Add a small README for people cloning this repo.

[matchsticks-search.git] / README

diff --git a/README b/README
new file mode 100644 (file)
index 0000000..874cc87
--- /dev/null
+++ b/README
@@ -0,0 +1,19 @@
+This git repository contains a collection of resources relating to a
+combinatorial problem described in the web page template file
+'template.html'.
+
+On a Linux system with the right libraries installed (e.g. install
+packages 'publib-dev' and 'libglpk-dev' on Ubuntu), running 'make'
+will build a linear-programming based exhaustive search program which
+you can run by typing (for example) './main 3 2'.
+
+An ILP-based and less rigorous search program (though faster for large
+m) is in 'partition.py', and expects the 'lp_solve' program on your
+path (install package 'lp-solve' on Ubuntu).
+
+The 'data' subdirectory contains all output we have so far collected
+from both of those programs, and 'tabulate.py' generates the full web
+page from template.html and that data.
+
+bounds.py is a Python library module which finds the best upper bound
+we can prove.