Customizing and Contributing to the Book¶
Note: the following instructions assume that you are connected to the Internet and that you have both the
universepackage repositories enabled. All unix shell commands are assumed to be running from your home directory ($HOME). Finally, any command that begins with
sudoassums that you have administrative rights on your machine. If you do not — please ask your system administrator about installing the software you need.
This book is free as in freedom, which means you have the right to modify it to suite your needs, and to redistribute your modifications so that our whole community can benefit.
That freedom lacks meaning, however, if you the tools needed to make a custom version or to contribute corrections and additions are not within your reach. This appendix attempts to put those tools in your hands.
Getting the Source¶
This book is marked up in ReStructuredText using a document generation system called Sphinx.
The source code is located on the Codeberg website at https://codeberg.org/OpenBookProject/thinkcscpp.
The easiest way to get the source code on a Debian 11 computer is:
sudo apt install git
on your system to install git.
to download the source for the book.
Making the HTML Version¶
To generate the html version of the book:
sudo apt install python3-sphinx
to install the Sphinx documenation generator.
to change into the
thinkcscppdirectory containing the book source.
to build the html from the ReStructuredText source.
The last command will run sphinx and create a directory named
containing the html verion of the text.