Skip to content

Commit

Permalink
Update README*.md: Windows 10 and Other Unix-like Systems
Browse files Browse the repository at this point in the history
For Windows 10, account for running scripts being disabled.

For Other Unix-like Systems, made formatting consistent with other sections.
  • Loading branch information
jayr0d committed Jan 27, 2024
1 parent b7fcb6b commit 9405602
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 4 deletions.
12 changes: 9 additions & 3 deletions README.dev.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,13 +94,19 @@ virtualenv -p python .venv
.venv\Scripts\activate.ps1
python -m pip install -e ".[dev]"
```

If `activate.ps1` cannot be loaded because running scripts is disabled on the system, run `activate.bat` instead or change the PowerShell execution policy `Set-ExecutionPolicy RemoteSigned -Scope CurrentUser`.
### Setup on Other Unix-like Systems
* install python 3.7 or greater
* install pip3
* install virtualenv
* cd _<rp2_directory>_
* `virtualenv -p python3 .venv`
* `.venv/bin/pip3 install -e '.[dev]'`

Then install RP2 Python package requirements:
```
cd <rp2_directory>
virtualenv -p python3 .venv
.venv/bin/pip3 install -e '.[dev]'
```

## Source Code
The RP2 source tree is organized as follows:
Expand Down
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,11 @@ pip install rp2
### Installation on Other Unix-like Systems
* install python 3.7 or greater
* install pip3
* `pip install rp2`

Then install RP2:
```
pip install rp2
```

## Running
RP2 requires two files as input:
Expand Down

0 comments on commit 9405602

Please sign in to comment.