Updated Docs (#327)

* Updated Docs

* Whitespace
This commit is contained in:
Michael
2021-04-14 17:37:27 -07:00
committed by GitHub
parent cf70b29694
commit 4aaf1dc2a5
15 changed files with 391 additions and 323 deletions

View File

@@ -5,17 +5,16 @@
This package includes a make file for easy development.
You can get use the make file by installing cargo make via `cargo install cargo-make`
### Commands
| Command | What it does |
|---------------------|--------------|
| makers format | Formats the `http-server` and `odin` |
| makers clippy | Builds and runs clippy on `http-server` and `odin` |
| makers build | Builds the two projects |
| makers start:dev | Formats, Clippy, docker-compose build, and docker-compose up |
| makers docker:build | Runs docker-compose build for the file `docker-compose.dev.yml` |
| makers docker:up | Runs docker-compose up for `docker-compose.dev.yml` |
| Command | What it does |
| ------------------- | ------------------------------------------------------------------------------ |
| makers format | Formats the `http-server` and `odin` |
| makers clippy | Builds and runs clippy on `http-server` and `odin` |
| makers build | Builds the two projects |
| makers start:dev | Formats, Clippy, docker-compose build, and docker-compose up |
| makers docker:build | Runs docker-compose build for the file `docker-compose.dev.yml` |
| makers docker:up | Runs docker-compose up for `docker-compose.dev.yml` |
| makers access | Runs `docker-compose -f docker-compose.dev.yml exec --user steam valheim bash` |
| makers access:admin | Runs `docker-compose -f docker-compose.dev.yml exec valheim bash` |
| makers release | Builds a release binary for `odin` and `http-server` |
| makers access:admin | Runs `docker-compose -f docker-compose.dev.yml exec valheim bash` |
| makers release | Builds a release binary for `odin` and `http-server` |