Browse Source

Documentation update.

Stefano Cossu 3 years ago
parent
commit
4f52b03cee
2 changed files with 22 additions and 1 deletions
  1. 2 0
      Makefile
  2. 20 1
      README.md

+ 2 - 0
Makefile

@@ -137,6 +137,7 @@ liblmdb:
 
 
 install: lib ## Install library and dependencies to $PREFIX. May require sudo.
+	@echo "Installing library files in $(PREFIX)."
 	cd $(MDB_DIR); PREFIX=$(PREFIX) make install
 	cd $(XXHASH_DIR); PREFIX=$(PREFIX) make install
 	mkdir -p $(DESTDIR)$(libdir)
@@ -146,6 +147,7 @@ install: lib ## Install library and dependencies to $PREFIX. May require sudo.
 
 
 debug_install: install debug ## Install standard and debug libraries.
+	@echo "Installing debug library files in $(PREFIX)."
 	cp liblsuprdf_dbg.{a,so} $(DESTDIR)$(libdir)
 	
 

+ 20 - 1
README.md

@@ -94,6 +94,13 @@ of features as a standalone library:
 The default `make` command compiles the library. Enter `make help` to get an
 overview of the other available commands.
 
+`make install` installs libraries and headers in the directories set by the
+environment variable `$PREFIX`. If this is unset, the default `/usr/local`
+prefix is used.
+
+Options to compile with debug symbols are available.
+
+
 ### Compile-Time Constants
 
 `DEBUG`: Set debug mode: memory map is at reduced size, logging is forced to
@@ -106,7 +113,19 @@ RDF source. The default value is 8192, which is mildly conservative. If you
 experience parsing errors on decoding, and they happen to be on a term such a
 very long string literal, try recompiling the library with a larger value.
 
-## Running and Embedding
+## Embedding
+
+The generated `liblsuprdf.so` and `liblsuprdf.a` libraries can be linked
+dynamically or statically to your code. Only the `lsup_rdf.h` header, which
+recursively includes other headers in the `include` directory, needs to be
+`#include`d in the embedding code.
+
+Environment variables and/or compiler options might have to be set in order to
+find the dynamic libraries and headers in their install locations.
+
+For compilation and linking examples, refer to `test`, `memtest`, `perftest`
+and other actions in the current Makefile.
+
 
 ### Environment Variables