Skip to content
This repository has been archived by the owner on Jul 31, 2023. It is now read-only.

Adds documentation for Docker #76

Open
wants to merge 1 commit into
base: dev
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
16 changes: 16 additions & 0 deletions README.md
Expand Up @@ -35,6 +35,22 @@ For "bleeding edge" changes, check out the `dev` branch.
python setup.py install
```

#### Docker

Docker support is available through the `dev` branch

1. Run the following command to build the image. Specify the image name and tag:

```bash
docker build -t <image_name>:<tag> .
```

2. Run the following command to create and start the image. Include `bash` to use an interactive shell

```bash
docker run -it --rm -v $(pwd):/<working_directory> <image_name>:<tag> [bash]
```

### Install from PyPi
```bash
pip install tfrecorder
Expand Down