#2374 Update readme and minor fix to yaml
This commit is contained in:
36
README.md
36
README.md
@@ -26,7 +26,7 @@ PrimAITE presents the following features:
|
|||||||
|
|
||||||
## Getting Started with PrimAITE
|
## Getting Started with PrimAITE
|
||||||
|
|
||||||
### 💫 Install & Run
|
### 💫 Installation
|
||||||
**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.
|
||||||
Currently, the PrimAITE wheel can only be installed from GitHub. This may change in the future with release to PyPi.
|
Currently, the PrimAITE wheel can only be installed from GitHub. This may change in the future with release to PyPi.
|
||||||
|
|
||||||
@@ -47,11 +47,6 @@ pip install https://github.com/Autonomous-Resilient-Cyber-Defence/PrimAITE/relea
|
|||||||
primaite setup
|
primaite setup
|
||||||
```
|
```
|
||||||
|
|
||||||
**Run:**
|
|
||||||
|
|
||||||
``` bash
|
|
||||||
primaite session
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Unix
|
#### Unix
|
||||||
|
|
||||||
@@ -75,12 +70,6 @@ pip install https://github.com/Autonomous-Resilient-Cyber-Defence/PrimAITE/relea
|
|||||||
primaite setup
|
primaite setup
|
||||||
```
|
```
|
||||||
|
|
||||||
**Run:**
|
|
||||||
|
|
||||||
``` bash
|
|
||||||
primaite session
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### Developer Install from Source
|
### Developer Install from Source
|
||||||
@@ -125,6 +114,29 @@ python3 -m pip install -e .[dev]
|
|||||||
primaite setup
|
primaite setup
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### Running PrimAITE
|
||||||
|
|
||||||
|
Use the provided jupyter notebooks as a starting point to try running PrimAITE. They are automatically copied to your PrimAITE notebook folder when you run `primaite setup`.
|
||||||
|
|
||||||
|
#### 1. Activate the virtual environment
|
||||||
|
|
||||||
|
##### Windows (Powershell)
|
||||||
|
```powershell
|
||||||
|
.\venv\Scripts\activate
|
||||||
|
```
|
||||||
|
|
||||||
|
##### Unix
|
||||||
|
```bash
|
||||||
|
source venv/bin/activate
|
||||||
|
```
|
||||||
|
|
||||||
|
#### 2. Open jupyter notebook
|
||||||
|
|
||||||
|
```bash
|
||||||
|
python -m jupyter notebook
|
||||||
|
```
|
||||||
|
Then, click the URL provided by the jupyter command to open the jupyter application in your browser. You can also open notebooks in your IDE if supported.
|
||||||
|
|
||||||
## 📚 Building documentation
|
## 📚 Building documentation
|
||||||
The PrimAITE documentation can be built with the following commands:
|
The PrimAITE documentation can be built with the following commands:
|
||||||
|
|
||||||
|
|||||||
@@ -1458,7 +1458,7 @@ simulation:
|
|||||||
options:
|
options:
|
||||||
db_server_ip: 192.168.1.14
|
db_server_ip: 192.168.1.14
|
||||||
services:
|
services:
|
||||||
- ty DNSClient
|
- type: DNSClient
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user