Mercurial > web-octave

annotate README.md @ 64:48f5e0fda5a8 kai

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add repository information.
author Kai T. Ohlhus <k.ohlhus@gmail.com>
date Tue, 11 Oct 2016 16:03:08 +0200
parents beb4387a8937
children bc79072a8169
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
31
beb4387a8937 Create README.md
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff changeset
1 # octave-web
beb4387a8937 Create README.md
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff changeset
2 Proposed update of [octave.org](http://www.octave.org).
beb4387a8937 Create README.md
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff changeset
3
beb4387a8937 Create README.md
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff changeset
4 ## Developing
64
48f5e0fda5a8 Add repository information.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 31
diff changeset
5
31
beb4387a8937 Create README.md
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff changeset
6 - Install Jekyll from Rubygems
64
48f5e0fda5a8 Add repository information.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 31
diff changeset
7
31
beb4387a8937 Create README.md
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff changeset
8 `gem install jekyll`
64
48f5e0fda5a8 Add repository information.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 31
diff changeset
9
31
beb4387a8937 Create README.md
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff changeset
10 - Compile the assets into `_site` (this directory is ignored by revision control and will be created on first build)
64
48f5e0fda5a8 Add repository information.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 31
diff changeset
11
31
beb4387a8937 Create README.md
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff changeset
12 `jekyll build`
64
48f5e0fda5a8 Add repository information.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 31
diff changeset
13
31
beb4387a8937 Create README.md
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff changeset
14 - Serve the site
beb4387a8937 Create README.md
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff changeset
15
beb4387a8937 Create README.md
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff changeset
16 `jekyll serve --watch`
64
48f5e0fda5a8 Add repository information.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 31
diff changeset
17
48f5e0fda5a8 Add repository information.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 31
diff changeset
18 ### Website HG repository
48f5e0fda5a8 Add repository information.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 31
diff changeset
19
48f5e0fda5a8 Add repository information.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 31
diff changeset
20 hg clone ssh://gnuoctave@octave.org/hg/web-octave
48f5e0fda5a8 Add repository information.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 31
diff changeset
21
31
beb4387a8937 Create README.md
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff changeset
22 ## Configuring
beb4387a8937 Create README.md
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff changeset
23 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.
beb4387a8937 Create README.md
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff changeset
24
beb4387a8937 Create README.md
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff changeset
25 ## Deploying
beb4387a8937 Create README.md
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff changeset
26 - Configure paths as needed in `_config.yml`
beb4387a8937 Create README.md
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff changeset
27 - Build the static site
64
48f5e0fda5a8 Add repository information.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 31
diff changeset
28
31
beb4387a8937 Create README.md
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff changeset
29 `jekyll build`
beb4387a8937 Create README.md
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff changeset
30
beb4387a8937 Create README.md
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff changeset
31 - Copy the static assets from `_site` to a server.
64
48f5e0fda5a8 Add repository information.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 31
diff changeset
32
48f5e0fda5a8 Add repository information.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 31
diff changeset
33 ### Website CVS repository at Savannah
48f5e0fda5a8 Add repository information.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 31
diff changeset
34
48f5e0fda5a8 Add repository information.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 31
diff changeset
35 export CVS_RSH=ssh
48f5e0fda5a8 Add repository information.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 31
diff changeset
36 cvs -z3 -d:ext:<Savannah account>@cvs.savannah.gnu.org:/web/octave co octave