more content to new readme file
authorpeusterm <manuel.peuster@uni-paderborn.de>
Fri, 8 Jul 2016 13:17:46 +0000 (15:17 +0200)
committerpeusterm <manuel.peuster@uni-paderborn.de>
Fri, 8 Jul 2016 13:17:46 +0000 (15:17 +0200)
README.md

index 734fad6..576e247 100755 (executable)
--- a/README.md
+++ b/README.md
@@ -5,7 +5,7 @@ This is the repository of [SONATA's](http://sonata-nfv.eu) emulation platform.
 
 This emulation platform was created to support network  service developers to locally prototype and test complete network service chains in realistic end-to-end multi-PoP scenarios. It allows the direct execution of real network functions, packaged as Docker containers, in emulated network topologies running locally on the network service developer's machine.
 
-More details about the the emulator's architecture and concepts can be found in the following publication:
+More details about the the emulator's architecture and concepts can be found in the following publication(s):
 
 * Peuster, Manuel, Holger Karl, and Steven van Rossem. ["MeDICINE: Rapid Prototyping of Production-Ready Network Services in Multi-PoP Environments."](http://arxiv.org/abs/1606.05995) pre-print arXiv:1606.05995 (2016).
 
@@ -36,19 +36,55 @@ Describe briefly how to build the software.
 * [zerorpc](http://www.zerorpc.io) >= 0.5.2 (MIT)
 
 ### Contributing
-(if applicable) Description (encouraging) how to contribute to this project/repository.
+Contributing to the Gatekeeper is really easy. You must:
+
+1. Clone [this repository](http://github.com/sonata-nfv/son-emu);
+2. Work on your proposed changes, preferably through submiting [issues](https://github.com/sonata-nfv/son-emu/issues);
+3. Submit a Pull Request;
+4. Follow/answer related [issues](https://github.com/sonata-nfv/son-emu/issues) (see Feedback-Chanel, below).
 
 ## Installation
-(if applicable) Describe briefly how to install the software. You may want to put a link to son-install instead:
+There are two ways to install and use son-emu. The simple one is to use Vagrant to create a VirtualBox-based VM on you machine that contains the pre-installed and configured emulator. The more complicated installation requires a freshly installed Ubuntu 14.04 LTS or 16.04 LTS and is done by a ansible playbook.
+
+### Vagrant Installation
+
+* Request VirtualBox and Vagrant to be installed on the system.
+* `git clone https://github.com/sonata-nfv/son-emu.git`
+* `cd ~/son-emu`
+* `vagrant up`
+* `vagrant ssh` to enter the new VM in which the emulator is installed.
+
+Follow the MOTD in the VM to run the example topology and the dummy-gatekeeper. The dummy-gatekeeper's default port 5000 is forwarded to the host machine and can be accessed from it by using, e.g., curl http://127.0.0.1:5000/packages.
 
-The installation of this component can be done using the [son-install](https://github.com/sonata-nfv/son-install) script.
+### Ansible Installation
+
+* Requires: Ubuntu 14.04 LTS or 16.04 LTS
+* `sudo apt-get install ansible git`
+* `sudo vim /etc/ansible/hosts`
+* Add: `localhost ansible_connection=local`
+
+#### 1. Containernet
+* `cd`
+* `git clone https://github.com/mpeuster/containernet.git`
+* `cd ~/containernet/ansible`
+* `sudo ansible-playbook install.yml`
+* Wait (and have a coffee) ...
+
+#### 2. Emulator
+* `cd`
+* `git clone https://github.com/sonata-nfv/son-emu.git`
+* `cd ~/son-emu/ansible`
+* `sudo ansible-playbook install.yml`
 
 ## Usage
 (if applicable) Describe briefly how to use the software.
 
+### CLI
+* [Full CLI command documentation](https://github.com/sonata-nfv/son-emu/wiki/CLI-Command-Overview)
+
 ## License
 
-This [SOFTWARE] is published under Apache 2.0 license. Please see the LICENSE file for more details.
+Son-emu is published under Apache 2.0 license. Please see the LICENSE file for more details.
 
 ## Useful Links
 
@@ -60,10 +96,10 @@ This [SOFTWARE] is published under Apache 2.0 license. Please see the LICENSE fi
 
 The following lead developers are responsible for this repository and have admin rights. They can, for example, merge pull requests.
 
-* Manuel Peuster (mpeuster)
-* Steven Van Rossem (stevenvanrossem)
+* Manuel Peuster (https://github.com/mpeuster)
+* Steven Van Rossem (https://github.com/stevenvanrossem)
 
 #### Feedback-Chanel
 
-* You may use the mailing list sonata-dev@lists.atosresearch.eu
-* Please use the GitHub issues to report bugs.
+* You may use the mailing list [sonata-dev@lists.atosresearch.eu](mailto:sonata-dev@lists.atosresearch.eu)
+* * [GitHub issues](https://github.com/sonata-nfv/son-emu/issues)