Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Merge pull request #37 from mhor/patch-2

fix screenshots
  • Loading branch information...
commit 4a38c502ae4902a17be6ccc2a8d0b7fc50f74f4d 2 parents fb129c6 + c3c9eba
@sickill authored
View
65 README.md
@@ -14,19 +14,19 @@ formats new commit messages with `git log` and shows desktop notification with
Fedora:
-![git-dude on Fedora](https://github.com/downloads/sickill/git-dude/git-dude-fedora-shot.png)
+![git-dude on Fedora](screenshots/git-dude-fedora-shot.png)
Ubuntu:
-![git-dude on Ubuntu](https://github.com/downloads/sickill/git-dude/git-dude-ubuntu-shot.png)
+![git-dude on Ubuntu](screenshots/git-dude-ubuntu-shot.png)
OSX:
-![git-dude on Mac OSX](https://github.com/downloads/sickill/git-dude/git-dude-osx-shot.png)
+![git-dude on Mac OSX](screenshots/git-dude-osx-shot.png)
Haiku:
-![git-dude on Haiku](https://github.com/downloads/sickill/git-dude/git-dude-haiku-shot.png)
+![git-dude on Haiku](screenshots/git-dude-haiku-shot.png)
## Requirements
@@ -42,8 +42,10 @@ On OSX:
## Installation
- $ curl -skL https://github.com/sickill/git-dude/raw/master/git-dude >~/bin/git-dude
- $ chmod +x ~/bin/git-dude
+```bash
+$ curl -skL https://github.com/sickill/git-dude/raw/master/git-dude >~/bin/git-dude
+$ chmod +x ~/bin/git-dude
+```
\* Make sure `~/bin` is in your `$PATH` or put `git-dude` script somewhere else
on your `$PATH`.
@@ -52,7 +54,9 @@ on your `$PATH`.
Git-dude can be installed with the following command:
-`brew install https://gist.github.com/lukaszkorecki/1289314/raw/022cd33fc366378552dc3527d72b994568644df1/git-dude.rb --HEAD`
+```bash
+$ brew install https://gist.github.com/lukaszkorecki/1289314/raw/022cd33fc366378552dc3527d72b994568644df1/git-dude.rb --HEAD
+```
The homebrew formula lives [here](https://gist.github.com/1289314).
@@ -63,13 +67,17 @@ directory is nothing more than container for cloned repositories of projects
you want to watch. Name it like you want, here for example we use
_~/.git-dude_:
- $ mkdir ~/.git-dude
- $ cd ~/.git-dude
+```bash
+$ mkdir ~/.git-dude
+$ cd ~/.git-dude
+```
Clone some repositories:
- $ git clone --mirror https://github.com/joelthelion/autojump.git
- $ git clone --mirror git://github.com/pyromaniac/hoof.git
+```bash
+$ git clone --mirror https://github.com/joelthelion/autojump.git
+$ git clone --mirror git://github.com/pyromaniac/hoof.git
+```
I recommend `git clone --mirror` - it doesn't checkout working directory so it
saves some disk space for bigger projects.
@@ -77,16 +85,22 @@ saves some disk space for bigger projects.
Symlinked repositories work too. This way you can monitor already cloned
projects:
- $ ln -s ~/code/tmuxinator .
+```bash
+$ ln -s ~/code/tmuxinator .
+```
Now run this to monitor _pwd_:
- $ git dude
+```bash
+$ git dude
+```
You can also pass directory name as first argument to specify which directory
to monitor instead of _pwd_.
- $ git dude ~/watched-repos
+```bash
+$ git dude ~/watched-repos
+```
This way you can have multiple _dude directories_ each being monitored by
separate git-dude process.
@@ -97,29 +111,40 @@ separate git-dude process.
Set how often git-dude should check for changes (in seconds, default: 60):
- $ git config --global dude.interval 30
+```bash
+$ git config --global dude.interval 30
+```
Set path to icon used by desktop notifications (default: none):
- $ git config --global dude.icon ~/.git-dude/github_32.png
+```bash
+$ git config --global dude.icon ~/.git-dude/github_32.png
+```
Set custom notification command (`$TITLE`, `$DESCRIPTION` and `$ICON_PATH`
environment variables are set when invoking notification command):
- $ git config --global dude.notify-command 'gntp-send "$TITLE" "$DESCRIPTION" "$ICON_PATH"'
- $ git config --global dude.notify-command 'echo -e "$TITLE\n\n\n$DESCRIPTION" | espeak --stdin -k20 -ven+12'
+```bash
+$ git config --global dude.notify-command 'gntp-send "$TITLE" "$DESCRIPTION" "$ICON_PATH"'
+$ git config --global dude.notify-command 'echo -e "$TITLE\n\n\n$DESCRIPTION" | espeak --stdin -k20 -ven+12'
+```
### Per-repository
Set path to icon used by desktop notifications for this repository (default:
taken from global setting):
- $ git config dude.icon ~/.git-dude/dm-core/datamapper.png
+```bash
+$ git config dude.icon ~/.git-dude/dm-core/datamapper.png
+```
Tell git-dude to ignore specific repository (if you want to _unmonitor_ it):
- $ git config dude.ignore true
+```bash
+$ git config dude.ignore true
+```
## Author
Marcin Kulik (http://ku1ik.com/ | @sickill)
+
View
BIN  screenshots/git-dude-fedora-shot.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
View
BIN  screenshots/git-dude-haiku-shot.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
View
BIN  screenshots/git-dude-osx-shot.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
View
BIN  screenshots/git-dude-ubuntu-shot.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Please sign in to comment.
Something went wrong with that request. Please try again.