diff options
| -rw-r--r-- | README.md | 31 |
1 files changed, 15 insertions, 16 deletions
@@ -16,19 +16,18 @@ project from this repo. $ cookiecutter https://github.com/thornycrackers/cookiecutter_docker.git ``` -After that if you have `docker` and `make` installed you can simply use the -following Makefile commands to start running the project. - -```bash -$ make build -$ make up -$ make enter -$ make down -$ make clean -``` - -- build: Build the docker container -- up: Spin up the docker container -- enter: Enter the running container -- down: Spin down the container but down remove -- clean: Remove a stopped container +You will be asked for a project name as well a a docker user. The project name +can be what ever you want and the docker user will be the prefix you use for +your images on dockerhub. E.g. My docker images are usually `thornycrackers/proj` +so I would use `thornycrackers`. After that you will have a new project setup +that includes a preset `docker-compose.yml` with a simple `Dockerfile` and a +`Makefile` that will automate controlling the container. The following commands +work out of the box. + +`make build` - Build your `docker_user/proj_name` image +`make up` - Spin up your container and forwards port 8000 by default and mounts local file +`make enter` - Open a bash terminal in the container +`make down` - Stop the container +`make clean` - Remove the stopped container + +[1]: https://github.com/audreyr/cookiecutter |