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

docs: update quickstart readme for installation covering new package option

Browse source
This commit is contained in:
Blake Harnden 2022-10-07 13:05:16 -07:00
parent c067de6792
commit 0d1fa0049a
1 changed files with 25 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

31
README.md
View file

@ -1,5 +1,4 @@
# CORE # CORE
CORE: Common Open Research Emulator CORE: Common Open Research Emulator
Copyright (c)2005-2022 the Boeing Company. Copyright (c)2005-2022 the Boeing Company.
@ -7,7 +6,6 @@ Copyright (c)2005-2022 the Boeing Company.
See the LICENSE file included in this distribution. See the LICENSE file included in this distribution.
## About ## About
The Common Open Research Emulator (CORE) is a tool for emulating The Common Open Research Emulator (CORE) is a tool for emulating
networks on one or more machines. You can connect these emulated networks on one or more machines. You can connect these emulated
networks to live networks. CORE consists of a GUI for drawing networks to live networks. CORE consists of a GUI for drawing
@ -15,12 +13,34 @@ topologies of lightweight virtual machines, and Python modules for
scripting network emulation. scripting network emulation.
## Quick Start ## Quick Start
Requires Python 3.6+. More detailed instructions and install options can be found
[here](https://coreemu.github.io/core/install.html).
The following should get you up and running on Ubuntu 18+ and CentOS 7+ ### Package Install
from a clean install, it will prompt you for sudo password. This would Grab the latest deb/rpm from [releases](https://github.com/coreemu/core/releases).
This will install vnoded/vcmd, system dependencies, and CORE within a python
virtual environment at `/opt/core/venv`.
```shell
sudo <yum/apt> install -y ./<package>
```
Then install OSPF MDR from source:
```shell
git clone https://github.com/USNavalResearchLaboratory/ospf-mdr.git
cd ospf-mdr
./bootstrap.sh
./configure --disable-doc --enable-user=root --enable-group=root \
--with-cflags=-ggdb --sysconfdir=/usr/local/etc/quagga --enable-vtysh \
--localstatedir=/var/run/quagga
make -j$(nproc)
sudo make install
```
### Script Install
The following should get you up and running on Ubuntu 22.04. This would
install CORE into a python3 virtual environment and install install CORE into a python3 virtual environment and install
[OSPF MDR](https://github.com/USNavalResearchLaboratory/ospf-mdr) from source. [OSPF MDR](https://github.com/USNavalResearchLaboratory/ospf-mdr) from source.
For more detailed installation see [here](https://coreemu.github.io/core/install.html).
```shell ```shell
git clone https://github.com/coreemu/core.git git clone https://github.com/coreemu/core.git
@ -36,7 +56,6 @@ inv install -p /usr
``` ```
## Documentation & Support ## Documentation & Support
We are leveraging GitHub hosted documentation and Discord for persistent We are leveraging GitHub hosted documentation and Discord for persistent
chat rooms. This allows for more dynamic conversations and the chat rooms. This allows for more dynamic conversations and the
capability to respond faster. Feel free to join us at the link below. capability to respond faster. Feel free to join us at the link below.