Aleš Erjavec avatar Aleš Erjavec committed 054fa97

Added a README.txt file.

Comments (0)

Files changed (2)

 orangekit.earth
 ===============
 
+`orangekit.earth` provides a an implementation of
+`Multivariate adaptive regression splines (MARS)`_ for the `Orange`_
+machine learning library. This implementation is based on the C code from
+`R package earth`_ by Stephen Milborrow.
+
+
+.. _`Multivariate adaptive regression splines (MARS)`: http://en.wikipedia.org/wiki/Multivariate_adaptive_regression_splines
+
+.. _`R package earth`: http://cran.r-project.org/web/packages/earth/index.html
+
+.. _`Orange`: http://orange.biolab.si
+
+
+Prerequisites
+-------------
+
+In order to use `orangekit.earth` you need to have already installed
+`Orange` (version 2.7 or latest).
+
+If you are installing from source you will also need the a working
+C compiler tool-chain.
+
+* On Windows install the free `Microsoft Visual C++ 2008 Express
+  <http://www.microsoft.com/express>`_ (`direct download link
+  <http://go.microsoft.com/fwlink/?linkid=244366>`_)
+
+* On Linux use you distribution's package management tools to install gcc
+
+* On Mac OSX install the `XCode developer tools
+  <http://developer.apple.com/xcode>`_
+
+
+Installing
+----------
+
+You can install it using pip or easy_install::
+
+   pip install orangekit.earth
+
+or::
+
+   easy_install orangekit.earth

docs/source/overview.rst

 .. _`Orange`: http://orange.biolab.si
 
 
-Requirements
-------------
+Prerequisites
+-------------
 
-In order to use orangekit.earth you need to have already installed
-`Orange` (version 2.7 or latest). If you are installing from source
-you will also need the a working C compiler tool-chain.
+In order to use `orangekit.earth` you need to have already installed
+`Orange` (version 2.7 or latest).
 
-
-Building from source
---------------------
-
-In order to build orangekit.earth from source you will need a working
+If you are installing from source you will also need the a working
 C compiler tool-chain.
 
 * On Windows install the free `Microsoft Visual C++ 2008 Express
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.