Skip to content

Latest commit

 

History

History
33 lines (25 loc) · 1.15 KB

README.md

File metadata and controls

33 lines (25 loc) · 1.15 KB
Raw

RAMP kit boilerplate

This is the official RAMP kit boilerplate using cookiecutter to help you setup a kit for your project.

Initializing a new kit

  1. install cookiecutter a Python library for project templates
pip install cookiecutter

or use alternative methods.

  1. run the following command and follow the instructions in your terminal
cookiecutter gh:ramp-kits/cookiecutter_ramp_kit

You'll be prompted for:

  • your name
  • your email address (best is the one used with git)
  • a GitHub username (yours if you want to keep it private, otherwise leave the default one ramp-kits)
  • the project name (spaces can be used)
  • the project slug = directory name of GitHub (must be concise and use underscore for spacing)
  • a short project description
  • the main task of your project
  • the type of input data
  • the choice of an open source license (or not)

This information will be used to set up the project (inner text and links) but will not be collected or tracked