Skip to content

Templates for Github

Use these README templates when creating a GitHub repository.

You can find the README templates on GitHub or download them here.

README for Software

Raw template

Project Title

Travis Coverage Docs nbviewer License
Conda

Overview

One paragraph project description goes here.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

What things you need to install the software and how to install them Give a list with links and how to install using code snippets.

brew install ...
npm install
conda install ...

Installing

A step by step on how to install the package.

Say what the step will be

Give the example

And repeat

until finished

End with an example of getting some data out of the system or using it for a little demo

Tests

Explain how to run the automated tests for this system

Deployment

Add additional notes about how to deploy this on a local machine and in a cloud provider.

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Release History

  • 0.4

  • CHANGES:

  • 0.3

  • CHANGES:

Authors

List authors and affiliation.

README for Workshops

Raw template

Workshop / Tutorial Title

Docs nbviewer License

Overview

One Paragraph of project description goes here

Date:
Location:

Getting started

Step by step with code on how to get up and running.

References

1 .
2 .

Authors

Other workshops and tutorials

Links to other workshops (Documentation and GitHub)

Badges

List of badges

Use the appropriate badges at the top of your README.md file, after the project title.

Travis CI

[![Travis](https://img.shields.io/travis/compbiocore/REPOSITORY_NAME.svg?style=flat-square)(LINK)

Travis

Code Coverage

Coveralls

[![Coveralls](https://img.shields.io/coveralls/compbiocore/REPOSITORY_NAME.svg?style=flat-square)](LINK)

Coveralls

Codecov

[![coverage](https://img.shields.io/codecov/c/github/compbiocore/REPOSITORY_NAME.svg?style=flat-square)](LINK)

codecov.io

Documentation

[![Docs](https://img.shields.io/badge/docs-stable-steelblue.svg?style=flat-square)](https://compbiocore.github.io/REPOSITORY_NAME)

Docs

Jupyter Notebooks

[![nbviewer](https://img.shields.io/badge/jupyter_notebooks-nbviewer-purple.svg?style=flat-square)](http://nbviewer.jupyter.org/github/compbiocore/REPOSITORY_NAME/)

nbviewer

Licenses

[![License](https://img.shields.io/badge/LICENSE_STRING-orange.svg?style=flat-square)](LINK)

Where LICENSE_STRING:
- MIT = license-MIT
- BSD 3-Clause = License-BSD%203--Clause

License
License

Conda

[![Conda](https://img.shields.io/conda/v/compbiocore/PACKAGE_NAME.svg?style=flat-square)](https://anaconda.org/compbiocore/PACAKGE_NAME)

Conda