Skip to content

Latest commit

 

History

History
29 lines (19 loc) · 734 Bytes

README.md

File metadata and controls

29 lines (19 loc) · 734 Bytes

Cookiecutter template for a research project

This is a template to for a research project using cookiecutter.

The template includes three folders:

  • data
  • doc-sphinx (documentation with sphinx)
  • scripts

Dependencies

You will need cookiecutter to initialize the project folder, and org-mode for Emacs and pandoc to use the documentation generation with Sphinx.

To install cookiecutter:

```
sudo pip install cookiecutter
```

Check the pandoc website for installation.

Initialize a new project folder

```
cookiecutter https://github.com/matthieu-bruneaux/cookiecutter-researchProject
```

This template is still being written. Use it at your own risks!