From 0d1fa0049a4e2417dfca69144d58e14c400b7ee9 Mon Sep 17 00:00:00 2001 From: Blake Harnden <32446120+bharnden@users.noreply.github.com> Date: Fri, 7 Oct 2022 13:05:16 -0700 Subject: [PATCH] docs: update quickstart readme for installation covering new package option --- README.md | 31 +++++++++++++++++++++++++------ 1 file changed, 25 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 8dbe4e56..63ab5892 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,4 @@ # CORE - CORE: Common Open Research Emulator 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. ## About - The Common Open Research Emulator (CORE) is a tool for emulating networks on one or more machines. You can connect these emulated 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. ## 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+ -from a clean install, it will prompt you for sudo password. This would +### Package Install +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 install -y ./ +``` + +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 [OSPF MDR](https://github.com/USNavalResearchLaboratory/ospf-mdr) from source. -For more detailed installation see [here](https://coreemu.github.io/core/install.html). ```shell git clone https://github.com/coreemu/core.git @@ -36,7 +56,6 @@ inv install -p /usr ``` ## Documentation & Support - We are leveraging GitHub hosted documentation and Discord for persistent chat rooms. This allows for more dynamic conversations and the capability to respond faster. Feel free to join us at the link below.