From 8a408f4436a4e438cd6e2f72c6b1dce636ecce04 Mon Sep 17 00:00:00 2001 From: Mathieu Jadin Date: Fri, 19 Jul 2019 16:10:30 +0200 Subject: [PATCH] Installation documentation --- README.md | 66 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 66 insertions(+) diff --git a/README.md b/README.md index bdb4d8f1..fd4fc9f8 100644 --- a/README.md +++ b/README.md @@ -7,3 +7,69 @@ IP addresses or router configuration files, ... [ipmininet/examples/README](ipmininet/examples/README.md) contains a description of the examples that come with this library. + +## Installation + +### Virtual Machine + +We maintain a [vagrant box](https://app.vagrantup.com/ipmininet/boxes/ubuntu-16.04) +packaged with all the daemons. +To use it, first install [Vagrant](https://www.vagrantup.com/downloads.html) +and [Virtualbox](https://www.virtualbox.org/wiki/Downloads) +and then, execute the following commands: +```bash +$ vagrant init ipmininet/ubuntu-16.04 +$ vagrant up +``` +This will create the VM. To access the VM with SSH, just issue the +following command in the same directory as the two previous one: +```bash +$ vagrant ssh +``` + +### Manual installation from sources + +To manually install IPMininet from source, first get the source code: + +```bash +$ git clone https://github.com/cnp3/ipmininet.git +$ cd ipmininet +$ git checkout +``` + +Then, install IPMininet, Mininet and all the daemons: + +```bash +$ sudo python util/install.py -iamf +``` + +You can choose to install only a subset of the daemons +by changing the options on the installation script. +For the option documentations, use the ``-h`` option. + +### Manual installation from PyPI + +Install Mininet by following its +[documentation](http://mininet.org/download/). + +Then, you can download and install IPMininet. + +```bash +$ sudo pip install ipmininet +``` + +Finally, you can install all the daemons: + +```bash +$ sudo python util/install.py -af +``` + +You can choose to install only a subset of the daemons +by changing the options on the installation script. +For the option documentations, use the ``-h`` option. + +## Contributions + +If you want to contribute, feel free to open a Pull Request. +[ipmininet/tests/README](ipmininet/tests/README.md) +contains the instructions to run the test suite of the library.