add contrib document

This commit is contained in:
Tommy Parnell
2018-06-09 12:43:56 -04:00
parent 0a400fc1e0
commit 7e6249869c

20
CONTRIBUTING.md Normal file
View File

@@ -0,0 +1,20 @@
Hi there,
feel free to contribute.
We have forked the Minimal theme from jekyll and made some changes. Such as the menu bar. For now the menu is hardcoded in html. If you add new sections to the page, you must add the links yourself in `_layouts/default.html`
BTW you can run the site locally.
To run the site you must install ruby 2.2, or higher. In a shell run the following.
```sh
gem install bundle
bundle
bundle exec jekyll serve
```
This should return a URL that you can visit in your browser.
Alternatively you can use any markdown editor, and it should provide a very close experience to the actual site, sans menu.