add rudimentary README file

1 files changed, 19 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c43e61a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,19 @@
+Program to fit to Poisson distributed data.
+
+Uses actual Poisson probability (i.e. not Gaussians, and
+therefore not least squares).
+
+### Installation
+
+Download using:<br>
+``git clone https://www.av8n.com/cgit/poissfit``
+
+Requires the `libnlopt-cxx-dev` package, which is easily installable on Ubuntu and similar platforms.
+
+In the poissfit directory, compile using a simple `make`
+command. That works on my Ubuntu platform. Other platforms are likely
+to work; the code uses fairly basic language features (c++11 or
+later).
+
+Some data files, suitable for input to the program, can be found
+[here](https://github.com/paulnord/bayesian_analysis).