From 662a044b2d362be3b4d4fa6ceb08ddf8dd8d4671 Mon Sep 17 00:00:00 2001 From: Acereca Date: Wed, 6 Apr 2022 15:28:04 +0200 Subject: [PATCH] add project usage --- README.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) 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 +```