update readme

This commit is contained in:
tamara-glazer
2021-04-02 17:37:32 -04:00
parent 1ea49d8722
commit 983c9d6cdc
+5 -1
View File
@@ -44,7 +44,7 @@ which is available now.
### The resulting directory structure
------------
The directory structure of your new project looks like this:
The directory structure of your new project looks like this:
```
├── LICENSE
@@ -64,6 +64,8 @@ The directory structure of your new project looks like this:
│ the creator's initials, and a short `-` delimited description, e.g.
│ `1.0-jqp-initial-data-exploration`.
├── pyproject.toml <- Project configuration file with settings for running black; see setuptools.readthedocs.io
├── references <- Data dictionaries, manuals, and all other explanatory materials.
├── reports <- Generated analysis as HTML, PDF, LaTeX, etc.
@@ -72,6 +74,8 @@ The directory structure of your new project looks like this:
├── requirements.txt <- The requirements file for reproducing the analysis environment, e.g.
│ generated with `pip freeze > requirements.txt`
├── setup.cfg <- Configuration file for flake8 and pep8
├── setup.py <- makes project pip installable (pip install -e .) so src can be imported
├── {{ cookiecutter.module_name }} <- Source code for use in this project.