git clone --depth=1 https://github.com/sboysel/project-template my-new-project
cd my-new-project
rm -rf .git
git initproject-template/
βββ conf # project configuration files
β βββ README.md
β βββ main.toml
βββ data # project data
β βββ output # final data output
β βββ temp # intermediate data objects
β βββ LICENSE # data-specific license
β βββ README.md
βββ doc # project documentation and write-up
β βββ notes
β βββ paper
β βββ references
β βββ slides
β βββ README.md
βββ log # store for log files
βββ output # final project outputs
β βββ figures
β βββ tables
βββ src # project source code
β βββ lib # code shared across modules
β βββ modules # project modules
β β βββ bar
β β βββ baz
β β βββ foo
β βββ test # unit tests, sanity checks, etc.
β βββ HEADER # project source code license header
β βββ README.md
βββ LICENSE # project license: BSD-3 for source code, CC-BY-4.0 for data
βββ Makefile # project build script (alternatives: simple scripts, other command runners)
βββ README.md # top-level project README
βββ TODO.md # project TODO list
As suggested by the American Economic Association:
- source code: BSD-3-Clause
- data: CC-BY-4.0