@@ -31,6 +31,28 @@ and `Twitter <https://twitter.com/SystemsAppr>`__. To read a running
3131commentary on how the Internet is evolving, follow the `Systems Approach
3232Blog <https://www.systemsapproach.org> `__.
3333
34+ Releases and Editions
35+ ---------------------
36+
37+ We continually release open source content in GitHub, with `print and
38+ ebook editions <https://www.systemsapproach.org/books.html> `__
39+ published from time-to-time. The latest print and ebook (1st Edition)
40+ corresponds to the ``v1.1 `` tag.
41+
42+ In general, ``master `` contains a coherent and internally consistent
43+ version of the material. (If it were code, the book would build and
44+ run.) Minor fixes are checked directly into ``master ``, but new
45+ content under development is checked into branches until it can be
46+ merged into ``master `` without breaking self-consistency. The web
47+ version of the book available at https://sdn.systemsapproach.org is
48+ then continuously generated from ``master ``.
49+
50+ Minor releases (e.g., ``v1.1 ``) are tagged whenever there is
51+ sufficient improvements or new content to warrant the effort. This is
52+ done primarily to create a snapshot so that everyone in a course can
53+ know they are using the same version.
54+
55+
3456Build the Book
3557--------------
3658
@@ -42,16 +64,23 @@ To build a web-viewable version, you first need to download the source:
4264 $ cd ~ /SDN
4365 $ git clone https://github.com/SystemsApproach/SDN.git
4466
45- The build process is stored in the Makefile and requires Python be
46- installed. The Makefile will create a virtualenv (``doc_venv ``) which
47- installs the documentation generation toolset.
67+ The build process is stored in the Makefile and requires Python be
68+ installed. The Makefile will create a virtualenv (``doc_venv ``) which
69+ installs the documentation generation toolset. You may also need to
70+ install the ``enchant `` C library using your system’s package manager
71+ for the spelling checker to function properly.
4872
4973To generate HTML in ``_build/html ``, run ``make html ``.
5074
5175To check the formatting of the book, run ``make lint ``.
5276
77+ To check spelling, run ``make spelling ``. If there are additional
78+ words, names, or acronyms that are correctly spelled but not in the dictionary,
79+ please add them to the ``dict.txt `` file.
80+
5381To see the other available output formats, run ``make ``.
5482
83+
5584Contribute to the Book
5685----------------------
5786
0 commit comments