Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jmduarte authored Nov 16, 2022
1 parent 254de6b commit 87a3b5e
Showing 1 changed file with 11 additions and 10 deletions.
21 changes: 11 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,34 +38,35 @@ $ cookiecutter https://github.com/FAIR4HEP/cookiecutter4fair
The directory structure of your new project looks like this:

```
├── LICENSE
├── LICENSE <- License for reusing code
├── Makefile <- Makefile with commands like `make data` or `make train`
├── README.md <- The top-level README for developers using this project.
├── CITATION.cff <- Standardized citation metadata
├── README.md <- The top-level README for developers using this project
├── data
│ ├── processed <- The final, canonical data sets for modeling.
│ └── raw <- The original, FAIR, and immutable data dump.
│ ├── processed <- The final, canonical data sets for modeling
│ └── raw <- The original, FAIR, and immutable data dump
├── Dockerfile <- For building a containerized environment
|
├── docs <- A default Sphinx project; see sphinx-doc.org for details
├── docs <- A default Sphinx project for documentation; see sphinx-doc.org for details
├── models <- Trained and serialized models, model predictions, or model summaries
├── notebooks <- Jupyter notebooks. Naming convention is a number (for ordering),
│ the creator's initials, and a short `-` delimited description, e.g.
│ `1.0-jqp-initial-data-exploration`.
├── references <- Data dictionaries, manuals, and all other explanatory materials.
├── references <- Data dictionaries, manuals, and all other explanatory materials
├── reports <- Generated analysis as HTML, PDF, LaTeX, etc.
│ └── figures <- Generated graphics and figures to be used in reporting
├── requirements.txt <- The requirements file for reproducing the analysis environment, e.g.
│ generated with `pip freeze > requirements.txt`
├── setup.py <- makes project pip installable (pip install -e .) so src can be imported
├── src <- Source code for use in this project.
│ ├── __init__.py <- Makes src a Python module
├── setup.py <- Makes project pip installable (`pip install -e .`) so src can be imported
├── src <- Source code for use in this project
│ ├── __init__.py <- Makes `src` a Python module
│ │
│ ├── data <- Scripts to download or generate data
│ │ └── make_dataset.py
Expand All @@ -81,7 +82,7 @@ The directory structure of your new project looks like this:
│ └── visualization <- Scripts to create exploratory and results oriented visualizations
│ └── visualize.py
└── tox.ini <- tox file with settings for running tox; see tox.readthedocs.io
└── tox.ini <- Tox file with settings for running `tox`; see tox.readthedocs.io
```

## Contributing
Expand Down

0 comments on commit 87a3b5e

Please sign in to comment.