From 520002c4df117b47bc2056f5552fcda8a2aa5109 Mon Sep 17 00:00:00 2001 From: David Hendriks <davidhendriks93@gmail.com> Date: Mon, 12 Aug 2019 18:52:28 +0100 Subject: [PATCH] small readme changes --- README.md | 19 +++++++++---------- 1 file changed, 9 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index fb1062371..4db61f86c 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -Python module for binary_c +# Python module for binary_c Based on a original work by Jeff Andrews, updated and extended for Python3 by Robert Izzard @@ -17,11 +17,11 @@ Environment variables Before compilation you should set the following environment variables: -required: BINARY_C should point to the root directory of your binary_c installation +required: `BINARY_C` should point to the root directory of your binary_c installation -recommended: LD_LIBRARY_PATH should include $BINARY_C/src and whatever directories are required to run binary_c (e.g. locations of libgsl, libmemoize, librinterpolate, etc.) +recommended: `LD_LIBRARY_PATH` should include `$BINARY_C/src` and whatever directories are required to run binary_c (e.g. locations of `libgsl`, `libmemoize`, `librinterpolate`, etc.) -recommended: LIBRARY_PATH should include whatever directories are required to build binary_c (e.g. locations of libgsl, libmemoize, librinterpolate, etc.) +recommended: `LIBRARY_PATH` should include whatever directories are required to build binary_c (e.g. locations of `libgsl`, `libmemoize`, `librinterpolate`, etc.) @@ -31,17 +31,16 @@ Build instructions To build the module, make sure you have built binary_c (with "make" in the binar_c root directory), its shared library (with "make libbinary_c.so" in the binary_c root directory), and set environment variables as described above, then run: ---- +``` make clean make ---- +``` -then to test the Python module +Then to test the Python module: ---- +``` python3 ./python_API_test.py ---- - +``` You will require whatever libraries with which binary_c was compiled, as well as the compiler with which Python was built (usually gcc, which is easily installed on most systems). -- GitLab