update readme

jpn-- · Jan 7, 2015 · 1131917 · 1131917
1 parent ee04b6b
commit 1131917
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 7 deletions.
diff --git a/.gitignore b/.gitignore
@@ -20,3 +20,4 @@ Icon
 *.graffle
 src/larch.py
 *.bat
+local/*
diff --git a/README.md b/README.md
diff --git a/README.rst b/README.rst
@@ -0,0 +1,16 @@
+larch
+=====
+
+**Larch**: the logit architect
+
+This is a tool for the estimation and application of logit-based discrete choice models.
+It is designed to integrate with NumPy and facilitate fast processing of linear models.
+If you want to estimate *non-linear* models, try `Biogeme <http://biogeme.epfl.ch/>`_,
+which is more flexible in form and can be used for almost any model structure.
+If you don't know what the difference is, you probably want to start with linear models.
+
+This project is very much under development.  There are plenty of undocumented functions
+and features; use them at your own risk.  Undocumented features may be non-functional, 
+not rigorously tested, deprecated or removed without notice in a future version.  If a
+function or method is documented here, it is intended to be stable in future updates.
+