Skip to content

Commit

Permalink
README: minor tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
ro6ley committed Mar 28, 2023
1 parent 6a02040 commit f4988a2
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,36 +70,36 @@ The following environment variables are needed to be set when running the bot:

* clone the repo:
```bash
$ git clone https://github.com/ro6ley/DoomAlerts.git
$ cd DoomAlerts
git clone https://github.com/ro6ley/DoomAlerts.git
cd DoomAlerts
```

* create the `.env` file and fill in the required details:
```bash
$ cp .env.example .env
cp .env.example .env
```

* build:
```bash
$ cargo install --path .
cargo install --path .
```

* start the application and run it in the background:
```bash
$ source .env
$ doom_alerts &
source .env
doom_alerts &
```

* run tests:
```bash
$ cargo test
cargo test
```

## Documentation

To view the project's documentation run:
```bash
$ cargo doc --no-deps --open
cargo doc --no-deps --open
```

### Docker
Expand All @@ -108,10 +108,10 @@ To run DoomAlerts using Docker:

* Build the image:
```bash
$ docker build -t doom_alerts .
docker build -t doom_alerts .
```

* Run it:
```bash
$ docker run --env-file .env doom_alerts
docker run --env-file .env doom_alerts
```

0 comments on commit f4988a2

Please sign in to comment.