diff options
| author | P. J. McDermott <pehjota> | 2012-10-28 16:29:06 (EDT) |
|---|---|---|
| committer | P. J. McDermott <pjm@nac.net> | 2012-10-28 16:29:06 (EDT) |
| commit | 7f7e3d98595921e0d772aeda068896fec99a92cd (patch) | |
| tree | b8142f51cc75a727c17b68c5460a6f9faa5c6eaa /dev | |
| parent | 00fbae28cc73634fda2477d925481702bee3980d (diff) | |
Publicly document the specs build process.
Diffstat (limited to 'dev')
| -rw-r--r-- | dev/specs.mdwn | 31 |
1 files changed, 31 insertions, 0 deletions
diff --git a/dev/specs.mdwn b/dev/specs.mdwn new file mode 100644 index 0000000..a632889 --- /dev/null +++ b/dev/specs.mdwn @@ -0,0 +1,31 @@ +[[!meta title="Specifications"]] + +Specifications for the distribution are maintained in the +[doc/specs.git][specs-git] repository and published in HTML format on the +[specs Web site][specs-www]. + + +Building Locally +================ + +Newer specifications like SPF 2.0 are multi-chapter books rendered from Markdown +source files using the custom-developed "markdownbook" software. markdownbook +is currently used as a submodule of the specs repository. + +One can download and build a local copy of the specifications from the +repository using the following commands: + + $ git clone git://git.os.libiquity.com/doc/specs.git + $ cd specs + $ git submodule init + $ git submodule update + $ make + +This will render HTML versions of the specifications in the source tree. You +can view these in a Web browser, e.g.: + + $ x-www-browser specs/spf-2.0/index.html + + +[specs-git]: http://git.os.libiquity.com/doc/specs.git +[specs-www]: http://specs.os.libiquity.com/ |