CONTRIBUTE.md

   1 ## Dev Requirements:
   2
   3 * [Myth](http://www.myth.io/)
   4 * [svgo](https://github.com/svg/svgo)
   5 * [cms7](https://github.com/edk0/cms7)
   6
   7 ## Building
   8
   9 Install `myth` and `svgo` globally by running `npm install -g myth svgo`.
  10
  11 Python 3 is needed for `cms7` to work. Make a virtualenv with `pyvenv env`,
  12 then run `pip install -r requirements.txt` to install `cms7`.
  13
  14 With dependencies installed, just run `cms7` to build. The output files are in
  15 the `out/` folder. You can run `python -m http.server` in the `out/` folder to
  16 serve the compiled files, and go to `http://localhost:8000` to see the files.
  17
  18 ## Git
  19
  20 `master` is automatically deployed to https://freenode.github.io/web-7.0/. It
  21 is also configured to reject commits that haven't had a build succeed in a
  22 branch or pull request; make one and ideally get someone else to confirm.
  23
  24 Branches are cheap; use one per feature.
  25
  26 Changes should be tested on both big and small screens.