X-Git-Url: https://osm.etsi.org/gitweb/?a=blobdiff_plain;f=README.md;h=92c36557e96b7e89311dfbf34f2fd50b8ebc5afe;hb=bd44f4aedca9d48d150939cd76d7cefe7e386aa2;hp=7b8fe6041a5806153c95a77257622154475f3eef;hpb=4883119e2b702cbc7a5a1f8251778ece25afcce4;p=osm%2Fvim-emu.git

diff --git a/README.md b/README.md
index 7b8fe60..92c3655 100644
--- a/README.md
+++ b/README.md
@@ -12,11 +12,24 @@
  * pip install import zerorpc
  * This will be replaced / extended by a REST API later
 
+### Project structure
+* **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
+ * **test/** Unit tests
+ * **example_topology.py** An example topology script to show how topologies can be specified
+
+### Run
+* First terminal:
+ * `sudo python example_topology.py`
+* Second terminal:
+ * TODO add CLI commands here (e.g. request the start of a new compute resource)
+
+
 ### TODO
 * DCemulator
- * correctly start and connect new compute resources at runtime
- * remove and disconnect compute resources at runtime
- * list active compute resources
+ * ...
 * Cloud-like reference API with CLI for demonstrations
  * Write CLI client
  * Start compute
@@ -34,3 +47,8 @@
 * Define API endpoints in topology
  * call startAPI from topology definition and start it in a own thread
  * make it possible to start different API endpoints for different DCs
+* DCemulator
+ * correctly start and connect new compute resources at runtime
+ * remove and disconnect compute resources at runtime
+ * do IP management for new containers
+ * list active compute resources