Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
74 changes: 45 additions & 29 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -1,29 +1,45 @@
BSD 3-Clause License

Copyright (c) 2020, PSLmodels/Git-Tutorial contributors
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.

3. Neither the name of the copyright holder nor the names of its contributors
may be used to endorse or promote products derived from this software
without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International

Copyright (c) 2026, PSLmodels/Git-Tutorial contributors

This work is licensed under the Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License ("CC BY-NC-SA 4.0").

Plain-English summary
=====================

You may:

* copy and share this material in any medium or format
* adapt, remix, transform, and build on this material

These permissions apply only if your use is non-commercial and you follow the license terms below.

You must:

* give appropriate attribution to PSLmodels/Git-Tutorial contributors
* include a copyright notice
* provide a link to the CC BY-NC-SA 4.0 license
* indicate whether you made changes
* distribute adaptations under the same CC BY-NC-SA 4.0 license or a Creative Commons compatible license

You may not:

* use this material for commercial purposes
* apply additional legal or technical restrictions that would limit other people from exercising the rights granted by the license
* imply that the licensors endorse you or your use of the material unless they have explicitly agreed to do so

Additional notes
================

* This summary is provided for convenience and does not replace the full license.
* Some uses may still require additional permissions if other rights are involved, such as privacy, publicity, or third-party rights.
* Exceptions and limitations to copyright law, such as fair use, are not affected by this license.

To view a copy of this license, visit:
https://creativecommons.org/licenses/by-nc-sa/4.0/

Or send a letter to:
Creative Commons
PO Box 1866
Mountain View, CA 94042
USA
5 changes: 5 additions & 0 deletions book/content/appendix/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Appendix

This appendix collects reference material that supports the main tutorial.

It currently includes the glossary.
5 changes: 5 additions & 0 deletions book/content/background/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Git and GitHub Background and History

This part of the book provides background on version control, Git, GitHub, and the broader collaboration context that made these tools so important.

The chapters in this section explain where Git came from, how GitHub grew into a dominant collaboration platform, and why Git-based workflows differ from simpler shared-document systems such as Google Docs or Dropbox.
4 changes: 4 additions & 0 deletions book/content/intro.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
numbering: false
---

(chap_intro)=
# Git and GitHub Tutorial Introduction

Expand Down
5 changes: 5 additions & 0 deletions book/content/repomgt/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Open Source Repository Management

This part of the book covers the repository-level practices that make collaboration more reliable and sustainable.

The chapters in this section discuss licensing, continuous integration, documentation, and virtual environments, all of which help a shared project stay usable for both maintainers and new contributors.
14 changes: 14 additions & 0 deletions book/content/repomgt/license.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,16 @@

Choosing a license is one of the most important early decisions for an open-source repository. A license tells other people what they are allowed to do with the code and what obligations come with that use.

## License used by this project

The Git Tutorial project is licensed under the Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International license (CC BY-NC-SA 4.0).

The copyright notice for the project should read:

`Copyright (c) 2026, PSLmodels/Git-Tutorial contributors`

This is a more restrictive license than permissive software licenses such as BSD or MIT because it requires attribution, limits use to non-commercial purposes, and requires adapted versions to be shared under the same license terms.

## Why a license matters

Without a license, a public GitHub repository may be visible, but others usually do not have clear legal permission to reuse, modify, or redistribute the code.
Expand All @@ -28,6 +38,10 @@ These licenses are often chosen when the project wants to maximize downstream ad

Copyleft licenses such as GPL require derivative works to remain under compatible open-source terms when distributed. These licenses are often chosen when maintainers want changes to remain open in downstream redistributions.

### Creative Commons licenses

Creative Commons licenses are more commonly used for documentation, books, and other written or creative works than for software source code. A license such as CC BY-NC-SA 4.0 allows sharing and adaptation with attribution, restricts commercial use, and requires derivatives to use the same license.

## Questions maintainers should ask

Before choosing a license, it helps to ask:
Expand Down
5 changes: 5 additions & 0 deletions book/content/txteditor/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Text Editor Git Configuration

This part of the book looks at how text editors can support a Git-based workflow without replacing the underlying Git concepts.

The chapters in this section provide an overview of editor integration and a more detailed walkthrough for Visual Studio Code.
5 changes: 5 additions & 0 deletions book/content/using/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Using Git and GitHub

This part of the book focuses on the practical workflow a contributor follows when using Git and GitHub.

The chapters in this section cover installation, configuration, account setup, basic terminology, collaborative workflow, merge conflicts, pull requests, attribution, advanced workflow topics, and a short command reference.
12 changes: 7 additions & 5 deletions book/myst.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,16 @@ project:
github: PSLmodels/Git-Tutorial
bibliography:
- _bibliography/references.bib
numbering:
title: true
toc:
- file: content/intro.md
- title: Git and GitHub Background and History
- file: content/background/index.md
children:
- file: content/background/VCgitHistory.md
- file: content/background/GitHubHistory.md
- file: content/background/GoogleDropboxBox.md
- title: Using Git and GitHub
- file: content/using/index.md
children:
- file: content/using/installing_git.md
- file: content/using/git_config.md
Expand All @@ -29,17 +31,17 @@ project:
- file: content/using/Attribution.md
- file: content/using/AdvancedGit.md
- file: content/using/GitCheatSheet.md
- title: Open Source Repository Management
- file: content/repomgt/index.md
children:
- file: content/repomgt/license.md
- file: content/repomgt/testing_CI.md
- file: content/repomgt/documentation.md
- file: content/repomgt/virt_env.md
- title: Text Editor Git Configuration
- file: content/txteditor/index.md
children:
- file: content/txteditor/TextEditorsIntro.md
- file: content/txteditor/VScode.md
- title: Appendix
- file: content/appendix/index.md
children:
- file: content/glossary.md

Expand Down
Loading