From 7e6249869c5d60bb1bc88eab45f4e18bc8d2bbae Mon Sep 17 00:00:00 2001 From: Tommy Parnell Date: Sat, 9 Jun 2018 12:43:56 -0400 Subject: [PATCH] add contrib document --- CONTRIBUTING.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..a68c17f --- /dev/null +++ b/CONTRIBUTING.md @@ -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. +