summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRichard Ipsum <richardipsum@fastmail.co.uk>2017-06-03 20:58:03 +0100
committerRichard Ipsum <richardipsum@fastmail.co.uk>2017-06-05 21:29:23 +0100
commit5fcf093b8a8880bda56e0b9afe0dee8e9927c4c5 (patch)
treed0e01ad3c4a2581931c5c02f2328f69e1309ba01
parentf848a19d352121a00b8526ed5c2ec60330e25ab2 (diff)
downloadlua-scrypt-5fcf093b8a8880bda56e0b9afe0dee8e9927c4c5.tar.bz2
README: add build instructions
-rw-r--r--README17
1 files changed, 16 insertions, 1 deletions
diff --git a/README b/README
index 9bed714..281956d 100644
--- a/README
+++ b/README
@@ -6,11 +6,26 @@ verification library. lua-scrypt uses the [libscrypt][] library and
provides a simple interface for hashing and verifying passwords.
local scrypt = require "scrypt"
-
+
local hash = scrypt.hash_password("Hello world")
assert(scrypt.verify_password(hash, "Hello world"))
+Installation
+============
+
+To compile lua-scrypt, on platforms with libscrypt 1.21 or later run,
+
+ $ make CFLAGS+=-DTRUST_LIBSCRYPT_SALT_GEN
+
+for platforms with older versions (earlier than 1.21) of libscrypt run,
+
+ $ make
+
+To install lua-scrypt, run,
+
+ $ make install
+
Thanks
======