Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
robotmaxtron authored Dec 9, 2016
1 parent 03fab30 commit 3038f85
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,15 @@ The new home of the ErgoDox project; an entirely open source, split hand, keyboa
Site is built with [Jekyll](http://jekyllrb.com/) and themed with [Docster](http://digitalmindch.github.io/docster-jekyll-theme/)

##Repo Structure:
Github page is served to ergodox.io from the deploy directory. `Jekyll build` in the /src directory will put the rendered files into this /deploy directory.
Github page is served to http://www.ergodox.io from the /deploy directory and the source code to render is all inside of the /src directory.

## Prerequsities
- jekyll
- jekyll-seo-tag
- jekyll-sitemap

## Building the site locally
Once you have Jekyll installed, navigate to the /src directory and ```jekyll serve``` or ```jekyll build``` to either build and serve the site locally or just build the site. The rendered files will be put in the /deploy directory.

## Ready to push to the live site?
`git subtree push --prefix deploy origin gh-pages`

0 comments on commit 3038f85

Please sign in to comment.