sdbx/study

Introduction

This repository was built in order to store the memos written as a result of learning git from reading Pro Git (2nd edition).

Memorial

25.08.16 ~ 25.10.29

This study group had ended in an enormous success; each participant accomplished the intended goal and acquired a fluent command of Git. May God bless our future.

Participants

• @tnraro
• @logic-finder

Directory Structure

pro-git
└ README.md   # contains the table of contents
└ <chapter-number>.<section-number>
  └ README.md   # contains the link to the corresponding webpage
  └ <participant>.md   # contains the participant's summary on that section

Helper Scripts

Use sc to run project helper commands from any directory. It switches to the project root, identifies the appropriate subcommand, and executes it with your arguments. In addition to the listed subcommands, custom commands can be easily added. For more details, see PR #7.

Quick Start

Run ./sc init to create a .env file at the project root. Then edit it to customize the environment variables.

$ ./sc init
# Then edit .env manually

Add a Summary File

Run ./sc add with a subdirectory name to create a summary file, stage it, and commit it. It also creates or updates any related files or directories if necessary.

./sc add 5.3

This opens the editor to modify the summary file or the README file.

Fix the Summary File

If the summary file contains errors or needs updates, run ./sc fix with a subdirectory name to open your editor, edit the summary, and commit with a sensible default message or a custom one.

./sc fix 5.3

Print Progress

To print progress indicating how many sections each participant has read, run ./sc tracker.

./sc tracker    # Prints overall progress.
./sc tracker 5  # Prints progress for chapter 5.