Skip to content

Latest commit

 

History

History
18 lines (14 loc) · 1.5 KB

README.md

File metadata and controls

18 lines (14 loc) · 1.5 KB

WorkshopExample

Coverage Status Codacy Badge Build Status License

A small github repo used as an example for the coding workshop!

To use this framework you will need to:

  1. Replace my email ([email protected]) with your own.
  2. Replace all instances of samreay & samuelreay, with your own username (case insensitive replace).
  3. Replace my name (Samuel Hinton) with yours (used in the doc and license).
  4. Update the project name if you rename it. (At this point, should have edits to .travis.yml, setup.py, README.md, conf.py, LICENSE.)
  5. Enable Travis, CodeCov and Codacy. (You may need to make a commit and push after enabling travis to kick off a build.)
  6. Update the codacy badge in this readme because it uses more than username/repo (get the badge from codacy project settings).
  7. Set an environment variable in travis called GITHUB_API_KEY with a Personal Access Token to commit Sphinx html to public repos.