summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorChristian Pointner <equinox@anylike.org>2009-12-25 07:49:33 +0000
committerChristian Pointner <equinox@anylike.org>2009-12-25 07:49:33 +0000
commitfee76a99f13148d95b7e660b6bf787cd695f9df8 (patch)
tree54e60dd61164e0512a67a493883ff102aeeb6073 /README
parentadded configure, makefile and initial manpage (diff)
added main files
updated readme (dependencies)
Diffstat (limited to 'README')
-rw-r--r--README85
1 files changed, 84 insertions, 1 deletions
diff --git a/README b/README
index 7a5fc30..1781a96 100644
--- a/README
+++ b/README
@@ -1,2 +1,85 @@
-... fill in some info ...
+Dependencies
+============
+anylike can be built using either libgcrypt or the openssl-crypto library.
+The latter is more performant in most cases but there are some license
+issues when using this library. It also needs more space when installed.
+
+
+Linux
+-----
+
+using libgcrypt:
+
+ build-essential
+ libgcrypt11-dev
+ liblua50-dev
+ liblualib50-dev
+
+using ssl crypto library:
+
+ build-essential
+ libssl-dev
+ liblua50-dev
+ liblualib50-dev
+
+if you want to rebuild the manpage:
+
+ asciidoc
+
+
+
+Installation
+============
+
+Getting the source via subversion:
+----------------------------------
+
+svn co https://svn.anylike.org/anylike/trunk anylike
+cd anylike
+
+
+Building from source
+--------------------
+
+using libgcrypt:
+
+# cd src
+# ./configure
+# make
+
+using ssl crypto library:
+
+# cd src
+# ./configure --use-ssl-crypto
+# make
+
+Notes:
+ - try './configure --help' for further information
+
+
+Installing
+----------
+
+# sudo make install
+
+This will install anylike under the --prefix defined with configure.
+
+
+Uninstalling
+------------
+
+# sudo make remove
+
+This removes everytthing except for the config files
+
+# sudo make purge
+
+This also removes the config files
+
+
+
+Usage:
+======
+
+tba.. \ No newline at end of file