Skip to content

Latest commit

 

History

History
63 lines (41 loc) · 2.29 KB

README_EN.md

File metadata and controls

63 lines (41 loc) · 2.29 KB
Raw

Upstream README (EN)

This is the English translation of the original German README.md file from the upstream project:

Translated using the DeepL/Translator free online service, and manually polished the text and formatting.

Source code for the Git Book

A rendered version can be found on gitbu.ch.

Pull-requests are welcome; however, this is a book that has been professionally edited repeatedly. Of course we want to maintain this quality standard. So before you make any major changes/extensions, please contact us so we can decide how to proceed. Error corrections or small updates are of course always welcome!

If you are a DocBook expert and/or web programmer and think: The design could be professionalized — then please do! I just took the source files and quickly put together a halfway decent website.

Build

Requirements: Installing asciidoc, dblatex and texlive-fonts-extra (for PDF).

Build:

  • make creates the HTML version.
  • xdg-open git.chunked/pr01.html opens the result in the browser.
  • make epub builds the EPUB version.
  • xdg-open git.epub opens the EPUB.
  • make pdf creates the PDF version.
  • xdg-open git.pdf opens the PDF.

Mac OS X

Setup (via Homebrew):

  • brew install asciidoc xmlstarlet epubcheck
  • xmllint fix:
  • sudo mkdir /etc/xml
  • sudo ln -s /usr/local/etc/xml/catalog /etc/xml/catalog

License

Licensed under the Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.