Document inline the various options to compile with embedding

1 files changed, 24 insertions, 1 deletions

diff --git a/demo/embedding_test.c b/demo/embedding_test.c
index 87d313b..224df1d 100644
--- a/demo/embedding_test.c
+++ b/demo/embedding_test.c
@@ -1,7 +1,30 @@
-/* Link this program with libembedding_test.so.
+/* There are two options:
+
+   =====1=====
+
+   Link this program with _embedding_test.so.
    E.g. with gcc:
 
       gcc -o embedding_test embedding_test.c _embedding_cffi*.so
+
+   You must then run the executable with the right command
+   (LD_LIBRARY_PATH on Linux), otherwise it won't find the
+   _embedding_cffi*.so:
+
+      LD_LIBRARY_PATH=. ./embedding_test
+
+   There are platform-specific options to gcc to avoid needing
+   that, too.  Linux:
+
+      gcc -o embedding_test embedding_test.c _embedding_cffi*.so -Wl,-rpath=.
+
+   =====2=====
+
+   Compile and link the _embedding_test.c source code together with
+   this example (e.g. with PyPy):
+
+      gcc -o embedding_test embedding_test.c _embedding_cffi.c  \
+          -I/opt/pypy/include -pthread -lpypy-c
 */
 
 #include <stdio.h>