Mercurial > web-octave
changeset 31:beb4387a8937
Create README.md
author | Alex Krolick <whokilledtheelectricmonk@gmail.com> |
---|---|
date | Sun, 27 Dec 2015 14:44:46 -0900 |
parents | 21fd6254edc3 |
children | 5b52eabee30a 80bd8cc6714d |
files | README.md |
diffstat | 1 files changed, 26 insertions(+), 0 deletions(-) [+] |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/README.md Sun Dec 27 14:44:46 2015 -0900 @@ -0,0 +1,26 @@ +# octave-web +Proposed update of [octave.org](http://www.octave.org). + +## Developing +- Install Jekyll from Rubygems + + `gem install jekyll` + +- Compile the assets into `_site` (this directory is ignored by revision control and will be created on first build) + + `jekyll build` + +- Serve the site + + `jekyll serve --watch` + +## Configuring +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. + +## Deploying +- Configure paths as needed in `_config.yml` +- Build the static site + + `jekyll build` + +- Copy the static assets from `_site` to a server.