Documentation for linux started. See #3 #6

lcodeca · Jul 31, 2020 · 4fe19c5 · 4fe19c5
1 parent 5257059
commit 4fe19c5
Show file tree

Hide file tree

Showing 4 changed files with 41 additions and 33 deletions.
diff --git a/README.md b/README.md
@@ -12,36 +12,6 @@ the Eclipse Public License 2.0 which is available at <http://www.eclipse.org/leg
 The intent of this git is to provide a Docker environment for [RLLIB+SUMO Utils](https://github.com/lcodeca/rllibsumoutils).
 It is based on the [Tensorflow Docker tutorial](https://www.tensorflow.org/install/docker), and presents the same the system requrements.
 
-## docker-cms.sh usage
+## Documentation
 
-``` bash
-Default parameters:
-  IMAGE name "tf-gpu-sumo-{today}"      [-n, --image-name]
-  IMAGE folder "docker-image"           [-f, --image-folder]
-  GPU enabled (true)                    [--no-gpu]
-  OPTIRUN disabled (false)              [--with-optirun]
-  BUILD: false                          [-b, --build]
-        with CACHE: false               [-c, --cache]
-  RUN: false                            [-r, --run]
-        with SCREEN: false              [-s, --screen]
-  EXEC: false                           [-e, --exec]
-        CONTAINER: "" (use docker ps for the id)
-  COMMAND: ""                           [--cmd]
-  EXP: ""                               [--exp]
-  DETACH: (true)                        [--detach]
-  DEVELOPMENT dir ""                    [-d, --devel]
-  LEARNING dir ""                       [-l, --learn]
-```
-
-Example of use:
-
-- Build the image (with GPU enabled) and launch the example learning in the terminal:
-    `bash docker-cmd.sh --build --cache --run`
-- Build the image with a specific name and launch the example learning in the terminal:
-    `bash docker-cmd.sh --image-name=rllibsumoutils-docker --build --cache --run`
-- Run the already built image in a screen:
-    `bash docker-cmd.sh --image-name=rllibsumoutils-docker --run --screen`
-- Attach to an already running docker container (using docker ps to know the id):
-    `bash docker-cmd.sh --exec=9ed3cec06e`
-- The default docker entry point in the image runs the tests. It can be changed by using:
-    `bash docker-cmd.sh --run --cmd="/bin/bash"`
+Documentation and HOWTOs are available in the `docs` folder.
diff --git a/docs/.placeholder b/docs/.placeholder
diff --git a/docs/howto-linux.md b/docs/howto-linux.md
@@ -0,0 +1,35 @@
+# RLLIB SUMO Docker environment for Linux
+
+## docker-cmd-linux.sh usage
+
+``` bash
+Default parameters:
+  IMAGE name "tf-gpu-sumo-{today}"      [-n, --image-name]
+  IMAGE folder "docker-image-linux"     [-f, --image-folder]
+  GPU enabled (true)                    [--no-gpu]
+  OPTIRUN disabled (false)              [--with-optirun]
+  BUILD: false                          [-b, --build]
+        with CACHE: false               [-c, --cache]
+  RUN: false                            [-r, --run]
+        with SCREEN: false              [-s, --screen]
+  EXEC: false                           [-e, --exec]
+        CONTAINER: "" (use docker ps for the id)
+  COMMAND: ""                           [--cmd]
+  EXP: ""                               [--exp]
+  DETACH: (true)                        [--detach]
+  DEVELOPMENT dir ""                    [-d, --devel]
+  LEARNING dir ""                       [-l, --learn]
+```
+
+Example of use:
+
+- Build the image (with GPU enabled) and launch the example learning in the terminal:
+    `bash docker-cmd-linux.sh --build --cache --run`
+- Build the image with a specific name and launch the example learning in the terminal:
+    `bash docker-cmd-linux.sh --image-name=rllibsumoutils-docker --build --cache --run`
+- Run the already built image in a screen:
+    `bash docker-cmd-linux.sh --image-name=rllibsumoutils-docker --run --screen`
+- Attach to an already running docker container (using docker ps to know the id):
+    `bash docker-cmd-linux.sh --exec=9ed3cec06e`
+- The default docker entry point in the image runs the tests. It can be changed by using:
+    `bash docker-cmd-linux.sh --run --cmd="/bin/bash"`
diff --git a/docs/index.md b/docs/index.md
@@ -11,3 +11,7 @@ the Eclipse Public License 2.0 which is available at <http://www.eclipse.org/leg
 
 The intent of this git is to provide a Docker environment for [RLLIB+SUMO Utils](https://github.com/lcodeca/rllibsumoutils).
 It is based on the [Tensorflow Docker tutorial](https://www.tensorflow.org/install/docker), and presents the same the system requrements.
+
+## HOWTOs
+
+- How to use the RLLIB SUMO Docker environment with linux [HOWTO](howto-linux.md)