/Git-Buch_EN

English translation of "Das Git-Buch" (The Git Book)

Primary LanguageAsciiDocOtherNOASSERTION

Build Status  project status  CC BY-NC-SA 4.0 License  project branch  free download 

Git-Buch, English Translation

English translation of Das Git-Buch (The Git Book) by Valentin Haenel and Julius Plenz, released under CC BY-NC-SA 4.0.

You can read the book online at the repository website:

or you can download the book as a self-contained single-file HTML document.

Translation project created by Tristano Ajmone in 2020/06/14. English translation by Alexander Bolli and Tristano Ajmone.

Table of Contents

Repository Map

Book Info

This is the English translation of the German book Git, Verteilte Versionskontrolle für Code und Dokumente (Git, Distributed version control for code and documents) by Valentin Haenel and Julius Plenz, 2nd Ed. 2014 — aka Das Git-Buch.

The Git book was published in paperback and eBook editions by Open Source Press (2003–2015), a Munich based computer book publisher specialized in open-source software and philosophy topics.

When Open Source Press ceased all publishing activities in December 2015, it transferred all the rights of the published texts back to their original authors. V.Haenel and J.Plenz decided to release their Git book under Creative Commons license, and published its full sources in AsciiDoc on GitHub:

This repository is dedicated to the English translation of the book, based on the original German repository (commit 76af76a).

Since in the German world the book is commonly referred to as Das Git-Buch (The Git Book), I've opted to name the translation project as Git-Buch EN as a way to emphasize the link to its original German edition and to avoid confusion with other similarly titled books already available in English.

Project Status

Although the book is still in its Beta stage, it has been entirely translated and therefore readers can start enjoying it without further ado.

There is still some polishing work to be done before the English book will reach v1.0.0:

  • The entire translation of the text and its footnotes is still a draft that needs revising and proofreading.
  • The book was ported to from AsciiDoc (Python) to our custom Asciidoctor (Ruby) toolchain, and there are still some formatting and styles issues to be dealt with.
  • Currently, only the HTML version of the book is available, but we're planning to add a PDF version too, but still need to chose which backend to use and then setup its toolchain, templates, etc.

In the meantime, the book will be updated regularly during its Beta stage, to ensure that all improvements are available to the reader.

License

This book is the English translation of the German book Das Git-Buch (The Git Book) by Valentin Haenel and Julius Plenz, released under CC BY-NC-SA 4.0 license; it's therefore a derivative work of the original book and bound by the same license terms.

"Git, Verteilte Versionskontrolle für Code und Dokumente"
(c) by Valentin Haenel and Julius Plenz

The "Git" book is licensed under a
Creative Commons Attribution-NonCommercial 4.0 International License.

You should have received a copy of the license along with this
work. If not, see <http://creativecommons.org/licenses/by-nc/4.0/>.

Credits

Due credits to third party tools and assets employed in this project.

Asciidoctor-Chunker

This project contains a slightly modified version of the asciidoctor-chunker tool:

Asciidoctor-Chunker was created by Wataru Shito and released under the MIT License:

MIT License

Copyright (c) 2018 Wataru Shito

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Rake Helpers Scripts

This project uses adapted versions of the Rake helpers modules from the alan-i18n repository:

The Ruby modules in that folder were created by Tristano Ajmone and released under the MIT License.

MIT License

Copyright (c) 2021 Tristano Ajmone

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Repository Info

Summary info on the repository and its current status.

The current development branch is beta-dev, all pull requests should be submitted there.

Branches

branch description
beta-dev * Current dev branch, until v1.0.0 is ready.
alpha-dev Old dev branch for the Alpha stage, no longer used.
master Main branch, no pull request allowed.
upstream-de-master Orphan mirror of master from gitbuch/gitbuch_cc upstream repo.

The beta-dev branch is the current development branch (until the book reaches v1.0.0); any pull requests should be submitted there.

The alpha-dev branch is no longer active, it's kept for reference purposes only.

The upstream-de-master orphan branch is a mirror of the master branch from the upstream repository, kept as a reference to the original files and in case we'll need to integrate future updates from the upstream project.

Building

The project utilizes Rake to handle building.

Local Preview

rake

builds a preview version of the book (untracked):

  • docs_src/Git-Book_Preview.html

This maintainers' preview version doesn't embed images via Data-URIs, to allow refreshing the document to view changed images. Furthermore, the TOC is set to maximum level, to allow easier navigation.

Publishing

rake publish

builds the website and the download version:

Any book formats added in the future will also be handled by this task.

Other Tasks

rake all

same as rake + rake publish

rake clobber

deletes all generated intermediate and target files, restoring the repository to a pristine state.

System Requirements

In order to build this repository you'll need:

Optionally, in order to edit and build the SVG diagrams:

In order to contribute to the repository, you'll also need:

Links

Git-Buch:

Open Source Press:

Wayback Machine archived pages from the original Git-Buch editions at Open Source Press website, 2015: