diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..0b6a16f --- /dev/null +++ b/README.md @@ -0,0 +1,27 @@ +OVERVIEW +======== + +duplicate\_finder scans paths and stores information about the files it finds. + +The information contains metadata from the filesystem but also hashes calculated +by reading the file. The data is collected in a sqlite database. + +OPTIONS +======= +Information can be found in the manpage or by calling the executable with `--help`. + +BUILD +===== + +`cmake -S .` + +`make` + +This will also build executables with debug options and create a manpage. +The latter requires `asciidoc`, `xmlto` and `gzip` for compression. + + + +TODO +==== + |