From f9fa1bbe580e992fc409e7533a5cad1d5fc258d0 Mon Sep 17 00:00:00 2001
From: David Hendriks <davidhendriks93@gmail.com>
Date: Sun, 28 Mar 2021 18:27:27 +0100
Subject: [PATCH] rewriting readme

---
 README.md | 27 +++++++++------------------
 1 file changed, 9 insertions(+), 18 deletions(-)

diff --git a/README.md b/README.md
index 5e9dfec62..6748dc191 100644
--- a/README.md
+++ b/README.md
@@ -3,8 +3,7 @@ Coverage: ![alt text](coverage.svg)
 Based on a original work by Jeff Andrews (can be found in old_solution/ directory)
 updated and extended for Python3 by Robert Izzard, David hendriks
 
-Requirements
----------------------
+## Requirements
 To run this code you need to at least have installations of:
 - Python3
 - binary_c version 2.1+
@@ -18,8 +17,7 @@ And the following python packages (which will get installed automatically when i
 - astropy
 - matplotlib
 
-Environment variables
----------------------
+## Environment variables
 Before compilation you need to have certain environment variables:
 
 Required:
@@ -27,20 +25,17 @@ Required:
 - `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.)
 - `LIBRARY_PATH` should include whatever directories are required to build binary_c (e.g. locations of libgsl, libmemoize, librinterpolate, etc.)
 
-Build instructions
-------------------
+## Build instructions
 First, make sure you have built binary_c (See `$BINARY_C/doc/binary_c2.pdf` section: installation for all the installation instructions for `binary_c`)) and that it functions correctly. 
 
-Installation via PIP:
-=====================
+### Installation via PIP:
 To install this package via pip:
 
 ```
 pip install binarycpython
 ```
 
-Installation from source:
-=========================
+### Installation from source:
 For this it is best to set up a virtual environment for this. Activate the virtualenvironment and enter the downloaded version of the repo. 
 
 Then run
@@ -50,20 +45,16 @@ python setup.py clean && python setup.py build --force && python setup.py sdist
 
 This will install this package into the virtual environment. Making changes to the sourcecode can be "installed" into the virtual env with the same command. 
 
-Examples
---------
+## Examples
 See the examples/ directory for example script. The documentation contains example pages as well. 
 
-Usage notes
------------
+## Usage notes
 Make sure that with every change/recompilation you make in `binary_c`, you also rebuild this package. 
 
-Documentation
--------------
+## Documentation
 Look in the doc/ directory. Within the build/html/ there is the html version of the documentation. 
 
-FAQ/Issues:
---------------------
+## FAQ/Issues:
 Building issues with binary_c itself: 
 - see the documentation of binary_c (in doc/). 
 - If you have MESA installed, make sure that the `$MESASDK_ROOT/bin/mesasdk_init.sh` is not sourced. It comes with its own version of some programs, and those can interfere with installing.  
-- 
GitLab