docs for libscrypt

Tarsnap · Apr 24, 2019 · 70ac8fe · 70ac8fe
1 parent 72a59fa
commit 70ac8fe
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 0 deletions.
diff --git a/BUILDING b/BUILDING
@@ -15,6 +15,15 @@ Official scrypt tarball releases should build and run on any IEEE Std 1003.1
   3. Provides /dev/urandom.
 
 
+libscrypt
+---------
+
+To install the development library, run:
+
+    ./configure --enable-libscrypt
+    make install
+
+
 Platform-specific notes
 -----------------------
 

diff --git a/README.md b/README.md
@@ -113,6 +113,16 @@ int crypto_scrypt(const uint8_t *, size_t, const uint8_t *, size_t, uint64_t,
     uint32_t, uint32_t, uint8_t *, size_t);
 ```
 
+There is a sample of using `crypto_scrypt()` in `tests/libscrypt`.  If you
+installed `libscrypt`, you can compile that file and run the binary:
+
+```
+$ cd tests/libscrypt/
+$ cc sample-libscrypt.c -lscrypt
+$ ./a.out
+crypto_scrypt(): success
+```
+
 
 Building
 --------