Skip to content

Commit

Permalink
updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
oscarlevin committed Aug 22, 2016
1 parent db2990a commit 350f2ea
Showing 1 changed file with 32 additions and 6 deletions.
38 changes: 32 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,20 +3,46 @@ discrete-book

An open textbook for Discrete Mathematics, as taught at the University of Northern Colorado. More information about the project is available on [the book's main website](http://discretetext.oscarlevin.com).

## Fall 2015 corrected edition

This current branch (Fall2015-corrected) contains the source files for the corrected version of the Fall 2015 edition. Use this in case you have that edition or want to continue using that edition. Most people will want to wait for the Fall 2016 edition, which will be released in early August. For progress on this, see the development branch.

## Compilation Instructions

To compile, compile the file "discretebook.tex" using pdfLaTeX or similar. If you would prefer to have margins more suitable for printing and binding (specifically two-sided), compile "discretebook-print.tex"
This text is written in [Mathbook XML](http://mathbook.pugetsound.edu), so the primary source files can be found in the MBX directory. These can be compiled into html or LaTeX files (as well as some other formats). If you do not want to bother with this step or just want to grab some LaTeX to use in a worksheet or the like, the generated LaTeX is already provided in the latex folder.

### MBX Compilation

To compile from source, you will need a copy of the mathbook xsl stylesheets, as well as xsltproc installed (should be easy on linux or MacOS, but also possible on Windows---see some [windows installation notes](http://mathbook.pugetsound.edu/doc/author-guide/html/windows-install-notes.html)).

Open up a terminal and in your preferred directory, clone the mathbook and discrete-book repositories:

`git clone https://github.com/rbeezer/mathbook`
`git clone https://github.com/oscarlevin/discrete-book`

To generate LaTeX, change to the latex directory of the discrete-book folder:

`cd discrete-book/latex`

and run

In case you would like to grab just single chapters or exercise sets, you *should* be able to compile each of those idividually as well (thanks to the DocMute package).
`xsltproc --xinclude ../xsl/dmoi-latex.xsl ../mbx/dmoi.mbx`

This will use the custom thin xsl stylesheet I have created with some customizations. It calls the mathbook-latex.xsl file from mathbook using relative paths, so it is important that you leave the mathbook and discrete-book directories parallel.

To generate html, change to the html folder. We first need to generate the svg images from the mbx code. This is done using the mbx script from mathbook:

`../../mathbook/script/mbx -v -c latex-image -f svg -d images ../mbx/dmoi.mbx`

You will need to have python and some other tools installed. See the mathbook documentation. Then to produce the html, run:

`xsltproc --xinclude ../xsl/dmoi-html.xsl ../mbx/dmoi.mbx`

## Contributing

Any and all suggestions to improve the text are welcome. Thanks to those who have already pointed out typos/issues they have found. If you would like to make a more substantial contribution, please contact me so we can discuss how best to proceed.

## Fall 2015 corrected edition

If you are looking for the previous edition of this text, switch branches to the Fall2015-corrected branch, which contains source files for the corrected version of the Fall 2015 edition. Use this in case you have that edition or want to continue using that edition.

## ToDo

Over the next few months (May to August 2016) I plan to convert the project to MathBookXML as well as make other improvements. A new edition will be available for the Fall 2016 semester.
While teaching Discrete Mathematics this fall semester, I will try to keep track of typos and other errors, as well as add exercises as I think of them.

0 comments on commit 350f2ea

Please sign in to comment.