afonso/core-extra
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

small tweaks to docs

Browse source
This commit is contained in:
Blake Harnden 2020-07-21 16:52:17 -07:00
parent d5d5da7256
commit 45bfa9fdad
2 changed files with 7 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/devguide.md
View file

@ -62,7 +62,7 @@ core-pygui
core-gui core-gui
# run mocked unit tests # run mocked unit tests
cd $REPO cd <CORE_REPO>
inv test-mock inv test-mock
``` ```

12
docs/install.md
View file

@ -58,7 +58,7 @@ before proceeding to install.
Previous install was built from source: Previous install was built from source:
```shell ```shell
cd $REPO cd <CORE_REPO>
sudo make uninstall sudo make uninstall
make clean make clean
./bootstrap.sh clean ./bootstrap.sh clean
@ -138,7 +138,7 @@ installed virtual environment.
There is an invoke task to help with this case. There is an invoke task to help with this case.
```shell ```shell
cd $REPO cd <CORE_REPO>
inv -h run inv -h run
Usage: inv[oke] [--core-opts] run [--options] [other tasks here ...] Usage: inv[oke] [--core-opts] run [--options] [other tasks here ...]
@ -153,7 +153,7 @@ Options:
Another way would be to enable the core virtual environment shell. Which Another way would be to enable the core virtual environment shell. Which
would allow you to run scripts in a more **normal** way. would allow you to run scripts in a more **normal** way.
```shell ```shell
cd $REPO/daemon cd <CORE_REPO>/daemon
poetry shell poetry shell
python run /path/to/script.py python run /path/to/script.py
``` ```
@ -168,7 +168,7 @@ which attempts to build EMANE from source, but has issue on systems with
older protobuf-compilers. older protobuf-compilers.
```shell ```shell
cd $REPO cd <CORE_REPO>
inv install-emane inv install-emane
``` ```
@ -180,8 +180,8 @@ bindings into the core virtual environment.
The following would install the EMANE python bindings after being The following would install the EMANE python bindings after being
successfully built. successfully built.
```shell ```shell
cd $REPO/daemon cd <CORE_REPO>/daemon
poetry run pip install $EMANE_REPO/src/python poetry run pip install <EMANE_REPO>/src/python
``` ```
## Using Invoke Tasks ## Using Invoke Tasks