Mercurial > web-octave
comparison README.md @ 31:beb4387a8937
Create README.md
| author | Alex Krolick <whokilledtheelectricmonk@gmail.com> |
|---|---|
| date | Sun, 27 Dec 2015 14:44:46 -0900 |
| parents | |
| children | 48f5e0fda5a8 e8fc61e077fc |
comparison
equal
deleted
inserted
replaced
| 30:21fd6254edc3 | 31:beb4387a8937 |
|---|---|
| 1 # octave-web | |
| 2 Proposed update of [octave.org](http://www.octave.org). | |
| 3 | |
| 4 ## Developing | |
| 5 - Install Jekyll from Rubygems | |
| 6 | |
| 7 `gem install jekyll` | |
| 8 | |
| 9 - Compile the assets into `_site` (this directory is ignored by revision control and will be created on first build) | |
| 10 | |
| 11 `jekyll build` | |
| 12 | |
| 13 - Serve the site | |
| 14 | |
| 15 `jekyll serve --watch` | |
| 16 | |
| 17 ## Configuring | |
| 18 See [_config.yml](_config.yml). In particular, `baseurl` will need to be adjusted to match the path of the subdirectory where the site will be hosted, e.g., for `gnu.org/octave` use `/octave`. Currently `baseurl` is set to the repository name in order to work with the Github Pages' build service. | |
| 19 | |
| 20 ## Deploying | |
| 21 - Configure paths as needed in `_config.yml` | |
| 22 - Build the static site | |
| 23 | |
| 24 `jekyll build` | |
| 25 | |
| 26 - Copy the static assets from `_site` to a server. |