diff python/pydc/README.txt @ 7:4fd959b3df78

- python binding readme clarifications
author cslag
date Sat, 26 Mar 2016 00:13:11 +0100
parents bf5625bb6f05
children 6493c9ed4b33
line wrap: on
line diff
--- a/python/pydc/README.txt	Sat Mar 26 00:12:40 2016 +0100
+++ b/python/pydc/README.txt	Sat Mar 26 00:13:11 2016 +0100
@@ -4,13 +4,14 @@
 Mar 22,2016: brought up to dyncall 0.9
 
 
-INSTALLATION
-------------
+BUILD/INSTALLATION
+------------------
 
 1) make sure dyncall is built and libraries/headers are in include paths or
    CFLAGS points to them, etc.
 
-2) python setup.py install
+2) Build and install this gem with:
+   python setup.py install
 
 
 API
@@ -20,7 +21,9 @@
 funcptr   = find(libhandle, symbolname)
 call(funcptr, signature, ...)
 
+
 SIGNATURE FORMAT
+----------------
 
   is a formated string
 
@@ -41,17 +44,17 @@
 
     y is result-type charcode  
 
-    'v' void
-    'B' bool              -> PyBool
-    'c' char              -> PyInt
-    's' short             -> PyInt
-    'i' int               -> PyInt
-    'j' long              -> PyLong
-    'l' long long         -> PyLongLong
-    'f' float             -> PyFloat (cast to double precision)
-    'd' double            -> PyFloat
-    'p' ptr               -> PyCObject encapsulating a void*
-    'Z' const char*       -> PyString
+    'v' C: void
+    'B' C++: bool         -> Python: PyBool
+    'c' C: char           -> Python: PyInt
+    's' C: short          -> Python: PyInt
+    'i' C: int            -> Python: PyInt
+    'j' C: long           -> Python: PyLong
+    'l' C: long long      -> Python: PyLongLong
+    'f' C: float          -> Python: PyFloat (cast to double precision)
+    'd' C: double         -> Python: PyFloat
+    'p' C: ptr            -> Python: PyCObject encapsulating a void*
+    'Z' C: const char*    -> Python: PyString
 
 
 BUGS