Merge pull request #1 from VIP-LES/develop

First testing ready version
VIP-LES · Mar 28, 2017 · 91be070 · 91be070
2 parents 6e57eb9 + b474cb6
commit 91be070
Show file tree

Hide file tree

Showing 5 changed files with 682 additions and 5 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,2 +1,3 @@
 env
-.idea
+.idea
+*.pyc
diff --git a/Dockerfile b/Dockerfile
@@ -12,7 +12,8 @@ RUN ./install_rtimulib.sh
 
 RUN pip install -r requirements.txt
 
-VOLUME /dev/geigerCounter
+VOLUME /dev/uart
+VOLUME /dev/i2c-0
 VOLUME /dev/i2c-1
 VOLUME /data
 

diff --git a/README.md b/README.md
@@ -19,7 +19,20 @@ Note that this step is completely optional and that it should be done only if no
 
 ### Installing and Running
 
-To run the project, a container must be created with this image and the correct parameters, including the unless-stopped restart policy and the correct volume links to any devices. Instructions will be added here shortly.
+To run the project, a container must be created with this image and the correct parameters, including the unless-stopped restart policy and the correct volume links to any devices. For example:
+
+```
+docker create \
+    --name=verne
+    -v /dev/ttyAMA0:/dev/uart \
+    -v /dev/i2c-0:/dev/i2c-0 \
+    -v /dev/i2c-0:/dev/i2c-1 \
+    -v /home/pi/vernedata:/data \
+    --restart=unless-stopped \
+    gtviples/verne
+```
+
+Then, the container can be started and stopped using the `docker start verne` and `docker stop verne` commands.
 
 ## Built With