diff options
Diffstat (limited to 'README.org')
| -rw-r--r-- | README.org | 90 |
1 files changed, 39 insertions, 51 deletions
@@ -1,71 +1,59 @@ -* Gitto +#+TITLE: gitto +#+STARTUP: showall - For lack of a better title. - - My simple utility to keep track of all the git repositories I have - on my computer(s). Also an experiment in writing scheme. - - Written for [[http://gnu.org/software/guile][GNU Guile]] 2.0.x - -** Installation - - Installing ~gitto~ is not really necessary, but it *is* more - convenient. In order to install it just run: +* NAME - : make install + gitto - A silly utility to track the status of some git + repositories. - This will install ~gitto~ to ~/usr/local/~, if you would like it - somewhere else you could use the ~DESTDIR~ variable: +* SYNOPSIS - : make install DESTDIR=/some/other/place + =gitto [command [subcommand] [args...]]= - This will install ~gitto~ to ~/some/other/place/~. +* DESCRIPTION -** Removal - - If you're fed up with ~gitto~ and want it gone, and I do mean *now*, - you can run: - - : make uninstall - - This will remove any ~gitto~ installed files from ~/usr/local/~, if you - used the ~DESTDIR~ variable during installation, you should give it - the same value here, like: + For lack of a better title. - : make uninstall DESTDIR=/some/other/place + My simple utility to keep track of all the git repositories I have on + my computer(s). Also an experiment in writing scheme. - This will remove any ~gitto~ installed files from ~/some/other/place/~. + Written for [[http://gnu.org/software/guile][GNU Guile]] 2.0.9 or newer -** Usage +* USAGE - Usage is, hopefully, simple, first you have to register some repos: + Usage is, hopefully, simple, first you have to register some repos: - : $ gitto -r ~/projects/project1 - : $ gitto -r ~/projects/project2 - : $ gitto -r ~/projects/project3 + : $ gitto add ~/projects/project1 + : $ gitto add ~/projects/project2 + : $ gitto add ~/projects/project3 - Then you can call ~gitto~ without any argument to see a list of your - repos and their statuses: + Then you can call ~gitto~ without any argument to see a list of your + repos and their statuses: - : $ gitto - : project1: 0 to push, 0 to pull and is dirty - : project2: 5 to push, 2 to pull and is not dirty - : project3: 0 to push, 1 to pull and is not dirty + : $ gitto + : project1: Worktree is dirty + : master: 0 to push and 0 to pull. Last update: 4 weeks ago + : + : project2: Worktree is clean + : master: 5 to push and 2 to pull. Last update: 2 days ago + : + : project3: Worktree is clean + : master: 0 to push and 1 to pull. Last update: 1 hour ago - If you're done with one of your projects and no longer wish to - track their status you can unregister them: + If you're done with one of your projects and no longer wish to track + their status you can unregister them: - : $ gitto -R ~/projects/project1 + : $ gitto remove ~/projects/project1 - If you require further assistance: + If you require further assistance: - : $ gitto -h + : $ gitto help -*** run-gitto +** run-gitto - As I mentioned, it is not completely necessary to install gitto, I - have added a utility to run it straight from je project directory, - although mostly for testing purposes. + It is not strictly necessary to install gitto, I have added a + utility to run it straight from je project directory, although + mostly for testing purposes. - Using ~run-gitto~ works exactly the same as using ~gitto~ when it is - installed. + Using ~run-gitto~ works exactly the same as using ~gitto~ when it is + installed. |