add a README

Signed-off-by: Sean Whitton <spwhitton@spwhitton.name>

1 files changed, 47 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..cf999e3
--- /dev/null
+++ b/README
@@ -0,0 +1,47 @@
+Git::Annex
+----------
+
+Perl interface to git-annex repositories, and some scripts which make
+use of this interface.  Requires git-annex installed to be useful.
+
+INSTALLATION
+
+To install this module, run the following commands:
+
+    % perl Makefile.PL
+    % make
+    % make test
+    % make install
+
+SUPPORT AND DOCUMENTATION
+
+After installing, you can find documentation for this module and its
+scripts with the perldoc & man commands.
+
+    % perldoc Git::Annex
+    % man annex-review-unused
+
+You can also look for information at:
+
+    RT, CPAN's request tracker (please see CONTRIBUTING.rst)
+        http://rt.cpan.org/NoAuth/Bugs.html?Dist=Git-Annex
+
+    MetaCPAN
+        https://metacpan.org/release/Git-Annex
+
+COPYRIGHT AND LICENCE
+
+Copyright (C) 2019-2020  Sean Whitton <spwhitton@spwhitton.name>
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or (at
+your option) any later version.
+
+This program is distributed in the hope that it will be useful, but
+WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.