X-Git-Url: https://osm.etsi.org/gitweb/?a=blobdiff_plain;f=README.md;h=31ba421ba06aa626a0eb156a756e6540a890194c;hb=95906762b28a11be154572dae68e354219ebcf03;hp=81f3f2067d676e938ad20dcc4eb4d73468d1bef2;hpb=97c30182e13fc1780611267988b49ff82813e9d5;p=osm%2Fvim-emu.git diff --git a/README.md b/README.md index 81f3f20..31ba421 100755 --- a/README.md +++ b/README.md @@ -19,11 +19,11 @@ To install the emulator package in development mode, do: #### Folder Structure -* `ansible` -* `misc` +* `ansible` Install scripts +* `misc` Example packages and VNFs * `src` - * `emuvim` - * `api` + * `emuvim` Emulator components + * `api` API endpoint implementations * `rest` REST API for son-emu-cli * `sonata` Dummy gatekeeper API * `cli` Command line client to control the emulator @@ -55,7 +55,6 @@ Despite of this son-emu has the following dependencies: * [flask_restful](https://pypi.python.org/pypi/Flask-RESTful) >= 0.3 (BSD) * [networkx](https://pypi.python.org/pypi/networkx/) >= 1.11 (BSD) * [oslo.config](http://docs.openstack.org/developer/oslo.config/) >= 3.9.0 (Apache 2.0) -* [paramiko](https://pypi.python.org/pypi/paramiko/1.16.0) >= 1.6 (LGPL) * [prometheus_client](https://pypi.python.org/pypi/prometheus_client) >= 0.0.13 (Apache 2.0) * [pyaml](https://pypi.python.org/pypi/pyaml) >=15.8.2 (WTFPL) * [pytest-runner](https://pypi.python.org/pypi/pytest-runner) >= 2.8 (MIT) @@ -68,7 +67,7 @@ Despite of this son-emu has the following dependencies: * [zerorpc](http://www.zerorpc.io) >= 0.5.2 (MIT) ### Contributing -Contributing to the Gatekeeper is really easy. You must: +Contributing to the son-emu 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); @@ -141,8 +140,9 @@ This example shows how to deploy a SONATA example package in the emulator using Note: The [son-push](https://github.com/mpeuster/son-cli) tool can be used instead of CURL. -### CLI Commands +### Further Documentation * [Full CLI command documentation](https://github.com/sonata-nfv/son-emu/wiki/CLI-Command-Overview) +* [Requirements for Docker containers executed by the emulator](https://github.com/sonata-nfv/son-emu/wiki/Container-Requirements) ## License @@ -160,7 +160,13 @@ The following lead developers are responsible for this repository and have admin * Manuel Peuster (https://github.com/mpeuster) * Steven Van Rossem (https://github.com/stevenvanrossem) +#### Contributors + +* Hadi Razzaghi Kouchaksaraei (https://github.com/hadik3r) +* Wouter Tavernier (https://github.com/wtaverni) +* Geoffroy Chollon (https://github.com/cgeoffroy) + #### Feedback-Chanel * 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) +* [GitHub issues](https://github.com/sonata-nfv/son-emu/issues)