aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorn-peugnet <n.peugnet@free.fr>2021-08-30 14:39:16 +0200
committern-peugnet <n.peugnet@free.fr>2021-08-30 14:42:57 +0200
commit05f21f3e95227f039d2b64bff4d123dd1edbdf5b (patch)
tree9c72c4855944429abf252fd065e1760ec778b1d8
parentafc30e335fb45910cb441956b239fc0d8f89446f (diff)
downloaddna-backup-05f21f3e95227f039d2b64bff4d123dd1edbdf5b.tar.gz
dna-backup-05f21f3e95227f039d2b64bff4d123dd1edbdf5b.zip
add basic readme
-rw-r--r--.gitignore3
-rw-r--r--README.md22
2 files changed, 25 insertions, 0 deletions
diff --git a/.gitignore b/.gitignore
index 348605c..2c790a9 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,2 +1,5 @@
+## Binaries
+dna-backup
+
## Test generated
test/repo
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..8d90902
--- /dev/null
+++ b/README.md
@@ -0,0 +1,22 @@
+# DNA Backup
+
+_Deduplicated versionned backups for DNA._
+
+## Requirements
+
+- Go >= 1.16
+
+## Instructions
+
+_Classical go_
+
+```bash
+# Build
+go build
+
+# Test
+go test
+
+# Run
+./dna-backup <source-dir> <repository>
+```