modificato README.MD e eliminata cartella .idea

collab-uniba · Sep 14, 2024 · 94ecd0c · 94ecd0c
1 parent 05e77dd
commit 94ecd0c
Show file tree

Hide file tree

Showing 10 changed files with 115 additions and 122 deletions.
diff --git a/.idea/.gitignore b/.idea/.gitignore
diff --git a/.idea/checkstyle-idea.xml b/.idea/checkstyle-idea.xml
diff --git a/.idea/make_documentation.iml b/.idea/make_documentation.iml
diff --git a/.idea/misc.xml b/.idea/misc.xml
diff --git a/.idea/modules.xml b/.idea/modules.xml
diff --git a/.idea/vcs.xml b/.idea/vcs.xml
diff --git a/.idea/workspace.xml b/.idea/workspace.xml
diff --git a/{{cookiecutter.project_name}}/README.MD b/{{cookiecutter.project_name}}/README.MD
diff --git a/README.md → {{cookiecutter.project_name}}/README.md b/README.md → {{cookiecutter.project_name}}/README.md
@@ -3,35 +3,40 @@ The following repository contains a template for AI-based Digital Health softwar
 
 ## Repository structure
 ```
-├── {{cookiecutter.project_name}}    <- Main project directory.
+|── .github                         <- directory containing configurations for Github Actions 
+│  └── workflow                   
+├── {{cookiecutter.project_name}}   <- Main project directory.
 │  ├── data
-│  │   ├── external       <- Data from third party sources.
-│  │   ├── interim        <- Intermediate data that has been transformed.
-│  │   ├── processed      <- The final, canonical data sets for modeling.
-│  │   └── raw            <- The original, immutable data dump.
-│  ├── docs               <- Directory for documentation.
-│  ├── example            <- Directory for test scripts and src.
-│  ├── models             <- Trained and serialized models, model predictions, or model summaries.
-│  ├── notebooks          <- Directory with Jupyter notebooks.
-│  ├── references         <- Directory containing project references.
-│  ├── reports            <- Generated HTML, PDF, LaTeX, etc. reports.
-│  │   └── figures        <- Graphs and figures generated to use in reports.
-│  ├── src                <- Project source code.
-│  │   ├── data           <- Scripts to download or generate data.
-│  │   ├── features       <- Scripts to turn raw data into features.
-│  │   ├── models         <- Scripts to train and use models.        
-│  │   └── visualization  <- Scripts to create visualizations.
-│  ├── test               <- Project test code.
+│  │   ├── external                 <- Data from third party sources.
+│  │   ├── interim                  <- Intermediate data that has been transformed.
+│  │   ├── processed                <- The final, canonical data sets for modeling.
+│  │   └── raw                      <- The original, immutable data dump.
+│  ├── docs                         <- Directory for documentation.
+│  │   ├── maker_documentation      <- Directory for creating documents
+│  │   ├── md_docs                  <- Directory containing documentation in Markdown format
+│  │   └──source                    <- Directory containing documentation template and test
+│  ├── example                      <- Directory for test scripts and src.
+│  ├── models                       <- Trained and serialized models, model predictions, or model summaries.
+│  ├── notebooks                    <- Directory with Jupyter notebooks.
+│  ├── references                   <- Directory containing project references.
+│  ├── reports                      <- Generated HTML, PDF, LaTeX, etc. reports.
+│  │   └── figures                  <- Graphs and figures generated to use in reports.
+│  ├── src                          <- Project source code.
+│  │   ├── data                     <- Scripts to download or generate data.
+│  │   ├── features                 <- Scripts to turn raw data into features.
+│  │   ├── models                   <- Scripts to train and use models.        
+│  │   └── visualization            <- Scripts to create visualizations.
+│  ├── test                         <- Project test code.
 │  │   ├── data           
 │  │   ├── features       
 │  │   ├── models             
 │  │   └── visualization  
-│  ├── Makefile           <- Makefile with `make install_requirements` command.
-│  ├── README.md          <- Project markdown file created.
-│  ├── requirements.txt   <- Txt file containing all requirements to install in venv.
-│  ├── setup.sh           <- Allows you to configure git and DVC.
-├── cookiecutter.json     <- Cookiecutter configuration file.
-├── README.md             <- Markdown file for developers utilizing the template.
+│  ├── Makefile                     <- Makefile with `make install_requirements` command.
+│  ├── README.md                    <- Project markdown file created.
+│  ├── requirements.txt             <- Txt file containing all requirements to install in venv.
+│  ├── setup.sh                     <- Allows you to configure git and DVC.
+│  ├── cookiecutter.json            <- Cookiecutter configuration file.
+│  └── README.md                    <- Markdown file for developers utilizing the template.
 ```
 
 

diff --git a/cookiecutter.json → ...iecutter.project_name}}/cookiecutter.json b/cookiecutter.json → ...iecutter.project_name}}/cookiecutter.json