diff --git a/README.md b/README.md index 0a4f4f1..8f444b0 100644 --- a/README.md +++ b/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. + +## 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 +```