Commit c4ddaf8f authored by William Roberts's avatar William Roberts
Browse files

Update README

parent 09419ea4
...@@ -78,6 +78,7 @@ environment for a container to run in. ...@@ -78,6 +78,7 @@ environment for a container to run in.
- Each container is an isolated entity which is not tied to local directories by default. - Each container is an isolated entity which is not tied to local directories by default.
- The flag `-v` is used to mount a local directory to a docker container. - The flag `-v` is used to mount a local directory to a docker container.
- You can mount multiple local directories. - You can mount multiple local directories.
- If inside an interactive docker container, type "exit" and enter.
- You can pass environment variables using the `-e` flag. - You can pass environment variables using the `-e` flag.
- You can set the default working directory using the `-w` flag. - You can set the default working directory using the `-w` flag.
...@@ -92,7 +93,7 @@ environment for a container to run in. ...@@ -92,7 +93,7 @@ environment for a container to run in.
# Quick Start # Quick Start
```console ```console
$ docker run --rm -it -v <data_dir>:<destination> aeri_armory $ docker run --rm -it -v <data_dir>:<destination> aeri_armory UTILITY_SCRIPT ...
``` ```
- `<data_dir>`: Absolute path of directory on your local machine to read data from and write data to. - `<data_dir>`: Absolute path of directory on your local machine to read data from and write data to.
...@@ -102,7 +103,7 @@ If input and output are not located in the same directory, you can mount both, t ...@@ -102,7 +103,7 @@ If input and output are not located in the same directory, you can mount both, t
script you decide to run: script you decide to run:
```console ```console
$ docker run --rm -it -v <input_dir>:/input -v <output_dir>:/output aeri_armory $ docker run --rm -it -v <input_dir>:/input -v <output_dir>:/output aeri_armory UTILITY_SCRIPT ...
``` ```
You are not restricted to `/input` and `/output`, they're just intuitive: You are not restricted to `/input` and `/output`, they're just intuitive:
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment