aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/README.md b/README.md
index ee80f5d..51142b3 100644
--- a/README.md
+++ b/README.md
@@ -2,6 +2,20 @@
Lua library that generate UUIDs leveraging [libuuid](http://linux.die.net/man/3/libuuid).
+## Requirements
+
+The `uuid/uuid.h` header must be available in the system `INCLUDE_PATH`, otherwise you will hit an error like:
+
+> ld: library not found for -luuid
+> …
+> Failed compiling module lua_uuid.so
+
+* Mac OS X
+ * `brew install ossp-uuid`
+* Debian Linux; Ubuntu
+ * `apt-get install uuid-dev`
+
+
## Usage
To generate a new UUID string: