Add README.md and gitignore for the Github mirror
authorMikael Berthe <mikael@lilotux.net>
Sat, 07 Apr 2018 21:13:49 +0200
changeset 27 a1b2568b1307
parent 26 a20d384dfab2
child 28 97b6e64cf579
Add README.md and gitignore for the Github mirror
.gitignore
README.md
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/.gitignore	Sat Apr 07 21:13:49 2018 +0200
@@ -0,0 +1,1 @@
+.hgignore
\ No newline at end of file
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README.md	Sat Apr 07 21:13:49 2018 +0200
@@ -0,0 +1,63 @@
+# goduf
+
+Goduf is a fast duplicate file finder.
+
+## Usage
+
+The typical usage is very simple:
+
+```
+% goduf DIRS...
+```
+
+Example:
+```
+% goduf /usr/bin
+Group #1 (2 files * 76 bytes):
+/usr/bin/vam
+/usr/bin/vim-addons
+
+Group #2 (2 files * 292 bytes):
+/usr/bin/pip
+/usr/bin/pip2
+
+Group #3 (3 files * 1134 bytes):
+/usr/bin/gajim
+/usr/bin/gajim-history-manager
+/usr/bin/gajim-remote
+
+Group #4 (2 files * 1303 bytes):
+/usr/bin/pdftexi2dvi
+/usr/bin/texi2pdf
+
+Group #5 (7 files * 4791 bytes):
+/usr/bin/ansible
+/usr/bin/ansible-console
+/usr/bin/ansible-doc
+/usr/bin/ansible-galaxy
+/usr/bin/ansible-playbook
+/usr/bin/ansible-pull
+/usr/bin/ansible-vault
+
+(...)
+```
+
+Use `goduf -h` to get the list of available options.
+
+*Note for Windows users*: goduf does not normalize paths on Windows, so be careful not to specify the same path twice.
+
+On Linux, hard links are automatically excluded.
+
+## Installation:
+
+From the Github mirror:
+
+```
+% go get hg.lilotux.net/golang/mikael/goduf
+```
+
+From my Mercurial repository (upstream):
+
+```
+% go get github.com/McKael/goduf
+```