Add installation intructions.

1 files changed, 21 insertions, 0 deletions

diff --git a/INSTALL b/INSTALL
new file mode 100644
index 0000000..090e834
--- /dev/null
+++ b/INSTALL
@@ -0,0 +1,21 @@
+To install the CLI and Iceweasel/Firefox addon, run (requires 'gzip' and
+'zip'):
+
+    make -C cli
+    sudo make -C cli install
+
+    make -C xul-ext ../icevault@guilhem.org.xpi
+    cp icevault@guilhem.org.xpi ~/.mozilla/firefox/*.default/extensions
+
+
+However users familiar with Debian packaging will probably prefer to
+build their own package:
+
+    git checkout debian
+    AUTO_DEBSIGN=no git buildpackage --git-force-create
+    VERSION=$(sed -nr '/^icevault \(([^)]+)\).*/ {s//\1/p;q}' debian/changelog)
+    sudo dpkg -i ../icevault_${VERSION}_all.deb ../xul-ext-icevault_${VERSION}_all.deb
+
+(Add the option '--git-upstream-tree=BRANCH' to the 'git buildpackage'
+command to package the development version rather than the last tagged
+release.)