# HG changeset patch
# User Alex Krolick <whokilledtheelectricmonk@gmail.com>
# Date 1451259886 32400
# Node ID beb4387a89378ab75f3d735907b92b63828687ed
# Parent  21fd6254edc3855321bba5a0ed6a015301680b55
Create README.md

diff -r 21fd6254edc3 -r beb4387a8937 README.md
--- /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.