Skip to content

Commit

Permalink
fix: inaccurate Python instructions (#74)
Browse files Browse the repository at this point in the history
  • Loading branch information
wesleyboar authored Aug 19, 2024
1 parent be9e88d commit 204f7d8
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,21 +38,22 @@ DesignSafe [MkDocs](https://mkdocs.readthedocs.io/) documentation with **customi
0. Have Python installed.\
<sup>Known supported versions are [from 3.10 to 3.12](https://github.com/DesignSafe-CI/DS-User-Guide/blob/tacc/tacc-docs/pyproject.toml#L9).</sup>
1. Navigate into your clone of this repo.
2. Install dependencies:\
<sup>You should only need to do this once, or after a new release.</sup>
2. Install software to manage dependencies:\
<sup>You should only need to do this once.</sup>
```shell
./bin/tacc-setup.sh
pip install poetry

```
3. Isolate dependencies:
3. Install/Update dependencies:\
<sup>You should only need to do this after new releases.</sup>
```shell
poetry shell
./bin/tacc-setup.sh
poetry install
```
4. Update & Serve the docs:
4. Serve the docs:
```shell
poetry install
poetry shell
cd user-guide
mkdocs serve
Expand Down

0 comments on commit 204f7d8

Please sign in to comment.