Skip to content

docs: improve readability of usage section in help #85

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dwilding merged 1 commit into from
Feb 23, 2026
Merged

docs: improve readability of usage section in help #85

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 10 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -323,15 +323,17 @@ gimmegit [<options>] <repo> [<new-branch>] [-- <git-options>] (1)
gimmegit [<options>] <branch-url> [-- <git-options>] (2)

1. Clone a GitHub repo and check out a new branch.
<repo> is one of:
• <owner>/<project>. For example, 'dwilding/frogtab'. <owner> is optional if the
GIMMEGIT_GITHUB_TOKEN environment variable contains a personal access token.
• A repo URL. For example, 'https://github.com/dwilding/frogtab'.
<new-branch> is the name of a branch that doesn't already exist. gimmegit generates a
branch name if you omit <new-branch>. For example, 'snapshot0801' on August 1.

2. Clone a GitHub repo and check out an existing branch.
<branch-url> is a URL such as 'https://github.com/dwilding/frogtab/tree/fix-something'.

<repo> One of:
• <owner>/<project>. For example, 'dwilding/frogtab'. <owner> is optional if
the GIMMEGIT_GITHUB_TOKEN environment variable contains an access token.
• A repo URL. For example, 'https://github.com/dwilding/frogtab'.

<new-branch> Name of a branch that doesn't already exist in the repo. gimmegit generates a
branch name if you omit <new-branch>. For example, 'snapshot0801' on August 1.

<branch-url> A branch URL such as 'https://github.com/dwilding/frogtab/tree/fix-something'.

▶ DIRECTORY STRUCTURE

Expand Down
18 changes: 10 additions & 8 deletions src/gimmegit/_help.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,17 @@
gimmegit [<options>] <branch-url> [-- <git-options>] (2)

1. Clone a GitHub repo and check out a new branch.
<repo> is one of:
• <owner>/<project>. For example, 'dwilding/frogtab'. <owner> is optional if the
GIMMEGIT_GITHUB_TOKEN environment variable contains a personal access token.
• A repo URL. For example, 'https://github.com/dwilding/frogtab'.
<new-branch> is the name of a branch that doesn't already exist. gimmegit generates a
branch name if you omit <new-branch>. For example, 'snapshot0801' on August 1.

2. Clone a GitHub repo and check out an existing branch.
<branch-url> is a URL such as 'https://github.com/dwilding/frogtab/tree/fix-something'.

<repo> One of:
• <owner>/<project>. For example, 'dwilding/frogtab'. <owner> is optional if
the GIMMEGIT_GITHUB_TOKEN environment variable contains an access token.
• A repo URL. For example, 'https://github.com/dwilding/frogtab'.

<new-branch> Name of a branch that doesn't already exist in the repo. gimmegit generates a
branch name if you omit <new-branch>. For example, 'snapshot0801' on August 1.

<branch-url> A branch URL such as 'https://github.com/dwilding/frogtab/tree/fix-something'.

▶ DIRECTORY STRUCTURE

Expand Down