add project usage
This commit is contained in:
parent
8d20a27094
commit
662a044b2d
29
README.md
29
README.md
|
@ -13,3 +13,32 @@ cookiecutter https://git.acereca.ne/acereca/CCSciPyMD.git
|
||||||
```
|
```
|
||||||
|
|
||||||
This will start the creation process and ask for a new project name.
|
This will start the creation process and ask for a new project name.
|
||||||
|
|
||||||
|
## Project Setup
|
||||||
|
|
||||||
|
The created project is then based on a makefile piepline.
|
||||||
|
|
||||||
|
1) run all data processing tasks with
|
||||||
|
```shell
|
||||||
|
make all
|
||||||
|
```
|
||||||
|
|
||||||
|
2) create reports based on the processing
|
||||||
|
```shell
|
||||||
|
make docs
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
To createa and view the documentation use
|
||||||
|
|
||||||
|
```shell
|
||||||
|
make mkdocs
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
Cleanup removes all files from `out/`
|
||||||
|
```shell
|
||||||
|
make clean
|
||||||
|
```
|
||||||
|
|
Loading…
Reference in New Issue