]> git.codecow.com Git - Monocypher.git/commitdiff
Added installation instructions to README.md
authorLoup Vaillant <loup@loup-vaillant.fr>
Sat, 23 Sep 2017 17:14:50 +0000 (19:14 +0200)
committerLoup Vaillant <loup@loup-vaillant.fr>
Sat, 23 Sep 2017 17:14:50 +0000 (19:14 +0200)
README.md

index 1b681194defda629f87580d5f2420a815dec6caa..f2eadb27eb33c382d7869ddded6f8712d24ea3fc 100644 (file)
--- a/README.md
+++ b/README.md
@@ -25,7 +25,17 @@ Alternatively, you can run
 
 then grab `lib/libmonocypher.a` or `lib/libmonocypher.so`.
 
-_TODO: make install_
+If you're running a UNIX system, install Monocypher on your system
+(you need to be root):
+
+    $ make install
+
+This will install Monocypher in `/usr/local/` by default. Libraries
+will go to `/usr/local/lib/`, the header in `/usr/local/include/`, and
+the man pages in `/usr/local/share/man/man3`.  If you just want the
+man pages, run this:
+
+    $ make install-doc
 
 
 ### Known language bindings