Skip to content

Commit

Permalink
docs: tidy path issue documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
jfmcquade committed Sep 12, 2024
1 parent bb70eb2 commit fbf68b6
Show file tree
Hide file tree
Showing 3 changed files with 2 additions and 6 deletions.
4 changes: 0 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,6 @@

## Installation

### Choosing a location to download the repo

Before running the commands, make sure you’re in the correct folder (the "current working directory") where you want to save the repo locally. You can use the `pwd` command to print the current directory, and `cd` to change the directory. You should ensure that there are no spaces at any point in the current working directory path. For example, if your top level user folder contains a space in the name, consider downloading the repo to a folder located outside of the user folder, e.g. in a new top-level `C:/apps` folder on Windows.

### Download the repo with binary assets

To download the repo into the current working directory, run:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ The scripts below will create a python [virtual environment](https://docs.python

```sh linenums="1"
cd documentation
python3 -m venv .venv
python -m venv .venv # Or `python3`, depending on python installation
source .venv/bin/activate
pip install -r requirements.txt
mkdocs serve
Expand Down
2 changes: 1 addition & 1 deletion documentation/docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
### Download the repo with binary assets
!!! tip "Choosing a location to download the repo"

Before running the commands, make sure you’re in the correct folder (the "current working directory") where you want to save the repo locally. You can use the `pwd` command to print the current directory, and `cd` to change the directory. You should ensure that there are no spaces at any point in the current working directory path. For example, if your top level user folder contains a space in the name, consider downloading the repo to a folder located outside of the user folder, e.g. in a new top-level `C:/apps` folder on Windows.
It is best to download the repo to a folder path that does not include any spaces. If using a user documents directory that includes spaces, e.g. `/user/my name`, you may need to re-open the terminal in a different folder instead.

To download the repo into the current working directory, run:
```
Expand Down

0 comments on commit fbf68b6

Please sign in to comment.