summaryrefslogtreecommitdiffstats
path: root/dev/specs.mdwn
blob: bfc81426f5e23d3640f9488eeb99595b7cde1e0c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
[[!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].

[specs-git]: http://git.proteanos.com/doc/specs.git/
[specs-www]: http://specs.proteanos.com/


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.proteanos.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