Skip to content

Commit

Permalink
docs: small adjustments to default readme and install overview
Browse files Browse the repository at this point in the history
  • Loading branch information
bharnden committed Nov 21, 2023
1 parent 3f8632f commit 3890e77
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 22 deletions.
26 changes: 17 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,46 @@
# CORE

CORE: Common Open Research Emulator

Copyright (c)2005-2022 the Boeing Company.
Copyright (c)2005-2023 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
topologies of lightweight virtual machines, and Python modules for
scripting network emulation.

## 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.

* [Documentation](https://coreemu.github.io/core/)
* [Discord Channel](https://discord.gg/AKd7kmP)

## Quick Start

Requires Python 3.9+. More detailed instructions and install options can be found
[here](https://coreemu.github.io/core/install.html).

### 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 <yum/apt> install -y ./<package>
```

Then install OSPF MDR from source:

```shell
git clone https://github.com/USNavalResearchLaboratory/ospf-mdr.git
cd ospf-mdr
Expand All @@ -38,6 +53,7 @@ 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.
Expand All @@ -54,11 +70,3 @@ inv install
# CentOS
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.

* [Documentation](https://coreemu.github.io/core/)
* [Discord Channel](https://discord.gg/AKd7kmP)
22 changes: 9 additions & 13 deletions docs/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,16 @@

## Overview

CORE currently supports and provides the following installation options, with the package
option being preferred.
This page will provide details on various options that can be used
when installing CORE.

* [Package based install (rpm/deb)](#package-based-install)
* [Script based install](#script-based-install)
### Complete Examples

For complete examples installing CORE, OSPF MDR, EMANE, and the EMANE python
bindings, see the pages below.

* [Installing on Ubuntu 22.04](install_ubuntu.md)
* [Installing on Rocky Linux 8](install_rocky.md)

### Requirements

Expand Down Expand Up @@ -97,15 +102,6 @@ sudo yum remove core
sudo apt remove core
```

## Installation Examples

The below links will take you to sections providing complete examples for installing
CORE and related utilities on fresh installations. Otherwise, a breakdown for installing
different components and the options available are detailed below.

* [Ubuntu 22.04](install_ubuntu.md)
* [Rocky Linux 8](install_rocky.md)

## Package Based Install

Starting with 9.0.0 there are pre-built rpm/deb packages. You can retrieve the
Expand Down

0 comments on commit 3890e77

Please sign in to comment.