diff --git a/README.md b/README.md index d00f07f..a3b5136 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,4 @@ -======================================== -Python Package and Notebook Cookiecutter -======================================== +# Python Package and Notebook Cookiecutter A project template for python projects and notebooks. This template is intended for researchers to organize small projects consisting of modules and notebooks. @@ -9,8 +7,7 @@ To learn more about cookiecutter: - Cookiecutter Homepage: https://cookiecutter.readthedocs.io/en/latest/ - Github: https://github.com/audreyr/cookiecutter -Project Status --------------- +## Project Status .. list-table:: :widths: 5 5 :header-rows: 0 @@ -22,55 +19,56 @@ Project Status - .. image:: https://github.com/n-wbrown/cookiecutter-python-notebook/actions/workflows/cookiecutter-test.yml/badge.svg?branch=dev :alt: dev status -Requirements for the Template ------------------------------ +## Requirements for the Template - Python >= 3.8 - `Cookiecutter Python package `_ >= 1.4.0: This can be installed with pip by or conda depending on how you manage your Python packages: -:: - +``` $ pip install cookiecutter +``` -or :: +or +``` $ conda install cookiecutter -c conda-forge +``` - - - -Starting a New Project ----------------------- +## Starting a New Project If using for the first time or in need of a new clone: :: +``` $ cookiecutter https://github.com/n-wbrown/cookiecutter-python-notebook +``` -or :: +or +``` $ cookiecutter gh:n-wbrown/cookiecutter-python-notebook +``` -Otherwise: :: +Otherwise: +``` $ cookiecutter cookiecutter-python-notebook +``` -For using a specific git tag of the cookiecutter: :: +For using a specific git tag of the cookiecutter: +``` $ cookiecutter cookiecutter-python-notebook --checkout v0.2 +``` - -Configuring a New Project -------------------------- +## Configuring a New Project setuptools-scm automatically configures versioning for you, with no setup steps required - when using pip. -Resulting Directory Structure ------------------------------ +## Resulting Directory Structure The directory structure of your new project looks like this: -.. code-block:: text - +``` │ ├── .gitignore <- Gitignore for the repo │ @@ -106,17 +104,17 @@ The directory structure of your new project looks like this: │ ├── docs-requirements.txt <- (Optional) Requirements to generate the sphinx documentation │ +``` -Installing Development Requirements ------------------------------------ -:: +## Installing Development Requirements +``` $ pip install -Ur requirements.txt $ pip install -Ur dev-requirements.txt $ pip install -Ur docs-requirements.txt +``` -Acknowledgements ----------------- +## Acknowledgements This repository is forked from from the work of SLAC National Accelerator Laboratory's controls team for the LCLS project. You can visit their original repository here: https://github.com/pcdshub/cookiecutter-pcds-python.