oxbrbtx/PrimAITE
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Updated the README.md with developer install specific instructions

Browse Source
This commit is contained in:
Chris McCarthy
2023-07-26 19:49:24 +01:00
parent 514f239cc6
commit eec1c25989
1 changed files with 15 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@@ -2,6 +2,7 @@
## Getting Started with PrimAITE ## Getting Started with PrimAITE
### Pre-Requisites ### Pre-Requisites
In order to get **PrimAITE** installed, you will need to have the following installed: In order to get **PrimAITE** installed, you will need to have the following installed:
@@ -12,38 +13,37 @@ In order to get **PrimAITE** installed, you will need to have the following inst
**PrimAITE** is designed to be OS-agnostic, and thus should work on most variations/distros of Linux, Windows, and MacOS. **PrimAITE** is designed to be OS-agnostic, and thus should work on most variations/distros of Linux, Windows, and MacOS.
### Installation from source ### Installation from source (Developer Install)
#### 1. Navigate to the PrimAITE folder and create a new python virtual environment (venv) #### 1. Create a new python virtual environment (venv)
```unix ```unix
python3 -m venv <name_of_venv> python3 -m venv venv
``` ```
#### 2. Activate the venv #### 2. Activate the venv
##### Unix ##### Unix
```bash ```bash
source <name_of_venv>/bin/activate source venv/bin/activate
``` ```
##### Windows ##### Windows (Powershell)
```powershell ```powershell
.\<name_of_venv>\Scripts\activate .\venv\Scripts\activate
``` ```
#### 3. Install `primaite` into the venv along with all of it's dependencies #### 3. Install `primaite` with the dev extra into the venv along with all of it's dependencies
```bash
python3 -m pip install -e .
```
### Development Installation
To install the development dependencies, postfix the command in step 3 above with the `[dev]` extra. Example:
```bash ```bash
python3 -m pip install -e .[dev] python3 -m pip install -e .[dev]
``` ```
#### 4. Perform the PrimAITE setup:
```bash
primaite setup
```
## Building documentation ## Building documentation
The PrimAITE documentation can be built with the following commands: The PrimAITE documentation can be built with the following commands:
@@ -53,7 +53,7 @@ cd docs
make html make html
``` ```
##### Windows ##### Windows (Powershell)
```powershell ```powershell
cd docs cd docs
.\make.bat html .\make.bat html