This repository houses the source code and content files for the open access, Git and GitHub Use, Collaboration, and Workflow book tutorial and training used by many contributors in the PSLmodels community. This project uses Jupyter Book and MyST to create the published HTML version of the tutorial. The source lives in this GitHub repository, and the compiled book is available at https://pslmodels.github.io/Git-Tutorial. This project is maintained by Richard W. Evans and Jason DeBacker.

We welcome contributions and updates to the content of the book. This is done by following fork/edit/pull-request workflow.

From your fork of this repository, you can generate your own version of the book by syncing the uv environment and using the Jupyter Book build commands.

This project uses uv for dependency management. If you do not already have uv installed, follow the official installation instructions in the uv documentation.

Once uv is installed, navigate to your local Git-Tutorial repository folder and sync the project dependencies with:

uv sync

Run the following command in your terminal from the repository root:

make book

The book target first removes the existing Jupyter Book build artifacts and then performs a fresh site build using uv run jupyter book build --all.

You can run the make serve command to do all the steps from make book, but further initiate a local server on which you can view, check, and validate the functioning web site.

make serve

This repository is actively maintained and contributions are welcome. The most helpful contributions usually improve tutorial clarity, correct command examples, add beginner-friendly explanations, or expand the hands-on workflow chapters.