readme: updated to add a quick start section
This commit is contained in:
parent
49709261fc
commit
c055103c1b
2 changed files with 38 additions and 2 deletions
31
README.md
31
README.md
|
@ -2,7 +2,7 @@
|
|||
|
||||
CORE: Common Open Research Emulator
|
||||
|
||||
Copyright (c)2005-2020 the Boeing Company.
|
||||
Copyright (c)2005-2021 the Boeing Company.
|
||||
|
||||
See the LICENSE file included in this distribution.
|
||||
|
||||
|
@ -14,6 +14,35 @@ networks to live networks. CORE consists of a GUI for drawing
|
|||
topologies of lightweight virtual machines, and Python modules for
|
||||
scripting network emulation.
|
||||
|
||||
## Quick Start
|
||||
|
||||
The following should get you up and running on Ubuntu 18+ and CentOS 7+
|
||||
from a clean install, it will prompt you for sudo password. This would
|
||||
install CORE into a python3 virtual environment and install
|
||||
[OSPF MDR](https://github.com/USNavalResearchLaboratory/ospf-mdr) from source.
|
||||
For more details on installation see [here](https://coreemu.github.io/core/install.html).
|
||||
|
||||
```shell
|
||||
git clone https://github.com/coreemu/core.git
|
||||
cd core
|
||||
```
|
||||
|
||||
Ubuntu:
|
||||
```shell
|
||||
./install.sh
|
||||
```
|
||||
|
||||
CentOS:
|
||||
```shell
|
||||
./install.sh -p /usr
|
||||
```
|
||||
|
||||
To additionally install EMANE:
|
||||
```shell
|
||||
reload
|
||||
inv install-emane
|
||||
```
|
||||
|
||||
## Documentation & Support
|
||||
|
||||
We are leveraging GitHub hosted documentation and Discord for persistent
|
||||
|
|
|
@ -91,7 +91,14 @@ After the installation complete it will have installed the following scripts.
|
|||
Please make sure to uninstall any previous installations of CORE cleanly
|
||||
before proceeding to install.
|
||||
|
||||
Previous install was built from source:
|
||||
Clearing out a current install from 7.0.0+, making sure to provide options
|
||||
used for install (`-l` or `-p`).
|
||||
```shell
|
||||
cd <CORE_REPO>
|
||||
inv uninstall
|
||||
```
|
||||
|
||||
Previous install was built from source for CORE release older than 7.0.0:
|
||||
```shell
|
||||
cd <CORE_REPO>
|
||||
sudo make uninstall
|
||||
|
|
Loading…
Reference in a new issue