Tweak things a bit more. Add usage guide to readme.

This commit is contained in:
James Smith 2023-01-28 22:44:51 +02:00
parent a6f922a0af
commit 639fe3c3b2
3 changed files with 14 additions and 1 deletions

View File

@ -17,6 +17,19 @@ git branch --merged | grep -v main | xargs git branch -d
with some extra convenience and (I hope) safety features. with some extra convenience and (I hope) safety features.
## Using
The actual script is named `git-tidy`. After cloning, you can copy (or symlink)
it to somewhere on your path (I use `~/bin/`).
Then when you `cd` to your git repository, you can type
```bash
git tidy
```
and it'll do its thing!
## Background
The repo is named with `-python` on the end because I have a vague ambition to The repo is named with `-python` on the end because I have a vague ambition to
redo this program in Go at some point, which will make it easier to distribute redo this program in Go at some point, which will make it easier to distribute
for people who don't have Python installed by default (i.e. Windows users). But for people who don't have Python installed by default (i.e. Windows users). But

View File

@ -1,4 +1,4 @@
[mypy] [mypy]
python_version = 3.10 python_version = 3.10
ignore_missing_imports = True ignore_missing_imports = True
files = git-tidy.py files = git-tidy