Skip to content
This repository was archived by the owner on Apr 14, 2025. It is now read-only.

Commit b3ba46f

Browse files
committed
📝 README complete install instruction
1 parent eb2731e commit b3ba46f

1 file changed

Lines changed: 40 additions & 7 deletions

File tree

README.md

Lines changed: 40 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,28 @@
77

88
A tool (cli & lib) to find local git repositories.
99

10-
## Why
10+
<!-- vscode-markdown-toc -->
11+
* [Why](#Why)
12+
* [Usage Cli](#UsageCli)
13+
* [Install](#Install)
14+
* [Via rust toolchain](#Viarusttoolchain)
15+
* [Via pre-build binaries](#Viapre-buildbinaries)
16+
* [Related and similar](#Relatedandsimilar)
17+
* [Informations](#Informations)
18+
* [Actions (broadcast)](#Actionsbroadcast)
19+
* [TODO](#TODO)
20+
21+
<!-- vscode-markdown-toc-config
22+
numbering=false
23+
autoSave=true
24+
/vscode-markdown-toc-config -->
25+
<!-- /vscode-markdown-toc -->
26+
27+
## <a name='Why'></a>Why
1128

1229
Because I need a tool to list and to reorg my local git repositories.
1330

14-
## Usage Cli
31+
## <a name='UsageCli'></a>Usage Cli
1532

1633
```sh
1734
$> git-find -h
@@ -40,31 +57,47 @@ ARGS:
4057
git find -t 'cd {{ .path.full }}; echo "\n\n---------------------------------------------\n$PWD"; git status' | sh
4158
````
4259

43-
## Install
60+
## <a name='Install'></a>Install
61+
62+
### <a name='Viarusttoolchain'></a>Via rust toolchain
4463

4564
```sh
4665
cargo install git-find
4766
```
4867

49-
## Related and similar
68+
### <a name='Viapre-buildbinaries'></a>Via pre-build binaries
69+
70+
*!! Experimental !!*
71+
72+
* download archives for your OS from https://github.com/davidB/git-find/releases
73+
* unarchive it, and move the executable into the PATH
74+
75+
```sh
76+
tar -xzvf git-find_0.2.2-linux.tar.gz
77+
chmod a+x git-find
78+
mv git-find $HOME/bin
79+
rm git-find_0.2.2-linux.tar.gz
80+
```
81+
82+
## <a name='Relatedandsimilar'></a>Related and similar
5083

5184
Some tools to help management of multi repository
5285
But not the same features, else no need to re-do.
5386

54-
### Informations
87+
### <a name='Informations'></a>Informations
5588

5689
* [peap/git-global: Keep track of all your git repositories.](https://github.com/peap/git-global) (I quickly look at the source to estimate my contribution to add features, but the "potentials" changes are too many and could change the goal usage of the tool)
5790
* [totten/git-scan: CLI tool for scanning/updating git repos](https://github.com/totten/git-scan/)
5891
* [fboender/multi-git-status: Show uncommitted, untracked and unpushed changes for multiple Git repos](https://github.com/fboender/multi-git-status)
5992

60-
### Actions (broadcast)
93+
### <a name='Actionsbroadcast'></a>Actions (broadcast)
6194

6295
* [gr - A tool for managing multiple git repositories](http://mixu.net/gr/)
6396
* [mu-repo](http://fabioz.github.io/mu-repo/), Tool to help working with multiple git repositories (short for Multiple Repositories).
6497
* [mr](http://myrepos.branchable.com/) which is a tool to manage all your version control repositories.
6598
* [Repo command reference | Android Open Source Project](https://source.android.com/setup/develop/repo)
6699

67-
## TODO
100+
## <a name='TODO'></a>TODO
68101

69102
* find a rust template engine that support calling method (getter) on current field (or contribute to gtmpl as it's a feature of go template)
70103
* internally use stream / queue instead of Vector

0 commit comments

Comments
 (0)