index/readme update

Author: nmiller95

README.md

@@ -1,32 +1,22 @@
 # PyJKTEBOP: A simple JKTEBOP python interface
 
-Compiles and runs the eclipsing binary fitting code JKTEBOP via a python script. Returns plots of the light curve (and radial velocity curve) and fit. Currently TASK3 (Levenberg-Marquardt minimisation) is supported, TASK 8 (Monte Carlo) and TASK9 (residual permutation) will follow in the near future.
+**PyJKTEBOP** is a simple, flexible Python interface for using the light curve fitting code [JKTEBOP](http://www.astro.keele.ac.uk/~jkt/codes/jktebop.html).
 
-This interface uses JKTEBOP (version 43); for information visit [John's website](http://www.astro.keele.ac.uk/~jkt/codes/jktebop.html).
+The JKTEBOP fortran code fits models to light curves and radial velocities of **detached eclipsing binary stars**. 
+The original code does not have plotting capability, which is where PyJKTEBOP comes in!
 
+PyJKTEBOP currently uses JKTEBOP version 43.
 
-Compilation
------------
+## Features
+- Compile and run JKTEBOP with Python
+- Run `TASK3` (Levenberg-Marquardt minimisation) with optional RVs
+- Run `TASK8` (Monte Carlo) and make a corner plot from the samples
+- Automatically take best parameters from `TASK8`, generate and plot the best model using `TASK3`
+- Customisable, auto-generated, publication standard plots via the included matplotlib style file
+- Scriptable or command-line interface
 
-JKTEBOP is written in FORTRAN 77, so you will need to check you have a suitable compiler on your system.
+## Documentation
+PyJKTEBOP documentation can now be found on [ReadTheDocs](https://pyjktebop.readthedocs.io/en/latest/)!
 
-You may need to modify the os.system() commands to suit your system. Quoting directly from JKTEBOP's documentation:
-
-> On a UNIX system and depending on your compiler use one of these commands:
-> * g77 -o jktebop jktebop.f
-> * g95 -o jktebop jktebop.f
-> * gfortran -o jktebop jktebop.f
-> * ifort -o jktebop jktebop.f
->
-> For Windows systems please refer to your FORTRAN compiler user manual (or alternatively get rid of Windows and use Linux instead)."
-
-
-Running
--------
-
-In `pyjktebop.py` you should adjust the setup parameters `target`, `rerun`, `rv_fit` and `mag_shift` to suit your needs. PyJKTEBOP assumes your JKTEBOP files have the same base name, i.e. setting `target='llaqr'` implies your files have names 'llaqr.in', 'llaqr.dat', etc. 
-
-To modify your fit parameters, change the values directly in the JKTEBOP configuration (.in) file. 
-
-#### Simultaneous LC-RV fitting
-PyJKTEBOP currently supports the JKTEBOP TASK3 routine with a light curve and optionally radial velocity data. Make sure your input files are labelled the same way as the example LL Aqr files in the JKTEBOP tarfile (see the [JKTEBOP website](https://www.astro.keele.ac.uk/jkt/codes/jktebop.html) to download the latest version): as before, with extensions -phot.dat, -rv1.dat and -rv2.dat. Read the JKTEBOP documentation for how to set up a fit with RVs.
+## Contributing
+Pull requests are welcome.

docs/source/index.rst

@@ -5,17 +5,18 @@ PyJKTEBOP: A simple Python JKTEBOP interface
 **PyJKTEBOP** is a simple, flexible Python interface for using the light curve fitting code
 `JKTEBOP <https://www.astro.keele.ac.uk/jkt/codes/jktebop.html>`__.
 
-The JKTEBOP fortran code fit models to light curves and radial velocities of detached eclipsing binary stars.
-The original code does not have plotting capability, which is where PyJKTEBOP comes in.
+The JKTEBOP fortran code fits models to light curves and radial velocities of **detached eclipsing binary stars**.
+The original code does not have plotting capability, which is where PyJKTEBOP comes in!
+
 PyJKTEBOP currently uses JKTEBOP version 43.
 
 Features
 ========
-- Compile and run JKTEBOP
+- Compile and run JKTEBOP with Python
 - Run ``TASK3`` (Levenberg-Marquardt minimisation) with optional RVs
 - Run ``TASK8`` (Monte Carlo) and make a corner plot from the samples
 - Automatically take best parameters from ``TASK8``, generate and plot the best model using ``TASK3``
-- Customisable plots using the included matplotlib style file
+- Customisable, auto-generated, publication standard plots via the included matplotlib style file
 - Scriptable or command-line interface
 
 .. toctree::