Merge pull request #66 from mpeuster/master

[osm/vim-emu.git] / README.md

diff --git a/README.md b/README.md
index c3fa61f..32a4652 100755 (executable)
--- a/README.md
+++ b/README.md
@@ -1,27 +1,47 @@
+[![Build Status](http://jenkins.sonata-nfv.eu/buildStatus/icon?job=son-emu)](http://jenkins.sonata-nfv.eu/job/son-emu)
+
 # Distributed Cloud Emulator
 
-Contributors:
+## Lead Developers
+The following lead developers are responsible for this repository and have admin rights. They can, for example, merge pull requests.
+
 
-* Manuel Peuster <manuel.peuster@upb.de>
+* Manuel Peuster (mpeuster)
+* Steven Van Rossem (stevenvanrossem)
 
 
-### Requirements
+### Dependencies
 * needs the latest [Dockernet](https://github.com/mpeuster/dockernet) to be installed on the system
- * the emulator is implemented against Dockernet's APIs
-* The emulator uses ZeroMQ based RPC to for communication between demo CLI client and cloud-like APIs
- * `pip install zerorpc`
- * (This will be replaced / extended by a REST API later)
+* pyaml
+* zerorpc
+* tabulate
+* argparse
+* networkx
+* six>=1.9
+* ryu
+* oslo.config
+* pytest
+* pytest-runner
+* Flask
+* flask_restful
+* requests 
+* docker-py
+
 
 ### Project structure
-* **emuvim/** all emulator code 
+
+* **src/emuvim/** all emulator code 
  * **api/** Data center API endpoint implementations (zerorpc, OpenStack REST, ...)
  * **cli/** CLI client to interact with a running emulator
  * **dcemulator/** Dockernet wrapper that introduces the notion of data centers and API endpoints
+ * **examples/** Example topology scripts
  * **test/** Unit tests
- * **example_topology.py** An example topology script to show how topologies can be specified
+* **ansible/** Ansible install scripts
+* **util/** helper scripts
 
 ### Installation
 Automatic installation is provide through Ansible playbooks.
+
 * Requires: Ubuntu 14.04 LTS
 * `sudo apt-get install ansible git`
 * `sudo vim /etc/ansible/hosts`
@@ -43,26 +63,28 @@ Automatic installation is provide through Ansible playbooks.
 
 
 ### Run
+
+In the `~/son-emu` directory:
+
+* During development:
+ * `python setup.py develop`
+* Otherwise, for a classic installation:
+ * `python setup.py install`
 * First terminal:
- * `cd ~/son-emu/emuvim`
- * `sudo python example_topology.py`
+ * `sudo python src/emuvim/examples/simple_topology.py 
+`
 * Second terminal:
- * `cd ~/son-emu/emuvim/cli`
- * `./son-emu-cli compute start -d datacenter1 -n vnf1`
- * `./son-emu-cli compute start -d datacenter1 -n vnf2`
- * `./son-emu-cli compute list`
+ * `son-emu-cli compute start -d datacenter1 -n vnf1`
+ * `son-emu-cli compute start -d datacenter1 -n vnf2`
+ * `son-emu-cli compute list`
 * First terminal:
  * `dockernet> vnf1 ping -c 2 vnf2`
 * Second terminal:
- *  `./son-emu-cli monitor get_rate -vnf vnf1` 
-
-#### Example scripts:
- * `./start_dcnetwork` starts an example datacenter network with monitoring api endpoint
- * `./start_example_chain` sets up an example service chain, using the example docker container from `package_samples` https://github.com/sonata-nfv/packaging_samples/tree/master/VNFs
+ *  `son-emu-cli monitor get_rate -vnf vnf1`
 
 ### Run Unit Tests
-* `cd ~/son-emu/emuvim`
-* `sudo python test` or `sudo python test -v` for more outputs
+* `cd ~/son-emu`
+* `sudo py.test -v src/emuvim` (equivalent to `python setup.py test -v --addopts 'src/emuvim'` but with direct access to the commandline arguments)
 
 ### CLI
 * [Full CLI command documentation](https://github.com/sonata-nfv/son-emu/wiki/CLI-Command-Overview)