Skip to content

Commit

Permalink
Slight tweaks to README for Windows set up & redoc typo (#189)
Browse files Browse the repository at this point in the history
## Description
Slightly updates the README to better reflect the work needed for
setting up on a Windows machine after setting up the repo on my desktop
this morning. Also found a small typo that I fixed.

## Related Issues
n/a

## Additional Notes
n/a
  • Loading branch information
m-goggins authored Feb 3, 2025
1 parent d76f725 commit e837f63
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ the virtual environment to stay active in your shell.
source scripts/bootstrap.sh
```

Note: If you are running in WSL on a Windows machine, will need to run the bootstrap file directly with `./scripts/bootstrap.sh` and then activate the virtual environment by running `.venv/bin/activate`.
Note: If you are running in WSL on a Windows machine, will need to run the bootstrap file directly with `./scripts/bootstrap.sh` and then activate the virtual environment by running `source .venv/bin/activate`.

### Running the API

Expand All @@ -37,7 +37,7 @@ To run the API locally, use the following command:
./scripts/local_server.sh
```

The API will be available at `http://localhost:8000`. Visit `http://localhost:8000/redocs` to view the API documentation.
The API will be available at `http://localhost:8000`. Visit `http://localhost:8000/redoc` to view the API documentation.

### Running unit tests

Expand Down

0 comments on commit e837f63

Please sign in to comment.