You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mahout.apache.org by ap...@apache.org on 2015/11/06 04:23:56 UTC

mahout git commit: (NOJIRA) Updated readme.txt to readme.md. closes apache/mahout#130, closes apache/mahout#172

Repository: mahout
Updated Branches:
  refs/heads/master 126c165ca -> 347c2f2ec


(NOJIRA) Updated readme.txt to readme.md.  closes apache/mahout#130, closes apache/mahout#172


Project: http://git-wip-us.apache.org/repos/asf/mahout/repo
Commit: http://git-wip-us.apache.org/repos/asf/mahout/commit/347c2f2e
Tree: http://git-wip-us.apache.org/repos/asf/mahout/tree/347c2f2e
Diff: http://git-wip-us.apache.org/repos/asf/mahout/diff/347c2f2e

Branch: refs/heads/master
Commit: 347c2f2ec61f6a83e06c00c19d069acaf3a938b7
Parents: 126c165
Author: Andrew Palumbo <ap...@apache.org>
Authored: Thu Nov 5 22:22:18 2015 -0500
Committer: Andrew Palumbo <ap...@apache.org>
Committed: Thu Nov 5 22:22:18 2015 -0500

----------------------------------------------------------------------
 README.md  | 51 +++++++++++++++++++++++++++++++++++++++++++++++++++
 README.txt | 18 ------------------
 2 files changed, 51 insertions(+), 18 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/mahout/blob/347c2f2e/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..0ca2305
--- /dev/null
+++ b/README.md
@@ -0,0 +1,51 @@
+Welcome to Apache Mahout!
+===========
+The Apache Mahoutâ„¢ project's goal is to build an environment for quickly creating scalable performant machine learning applications.
+
+For additional information about Mahout, visit the [Mahout Home Page](http://mahout.apache.org/)
+
+####Setting up your Environment
+Whether you are using Mahout's Shell, running command line jobs or using it as a library to build your own apps you'll need to setup several environment variables. Edit your environment in `~/.bash_profile` for Mac or `~/.bashrc` for many linux distributions. Add the following
+```
+export MAHOUT_HOME=/path/to/mahout
+export MAHOUT_LOCAL=true # for running standalone on your dev machine, 
+# unset MAHOUT_LOCAL for running on a cluster
+```
+You will need a `$JAVA_HOME`, and if you are running on Spark, you will also need `$SPARK_HOME`
+
+####Using Mahout as a Library
+Running any application that uses Mahout will require installing a binary or source version and setting the environment.
+To compile from source:
+* `mvn -DskipTests clean install`
+* To run tests do `mvn test`
+* To set up your IDE, do `mvn eclipse:eclipse` or `mvn idea:idea`
+
+To use maven, add the appropriate setting to your pom.xml or build.sbt following the template below.
+
+
+To use the Samsara environment you'll need to include both the engine neutral math-scala dependency:
+```
+<dependency>
+    <groupId>org.apache.mahout</groupId>
+    <artifactId>mahout-math-scala_2.10</artifactId>
+    <version>${mahout.version}</version>
+</dependency>
+```
+and a backing engine, e.g:
+```
+<dependency>
+    <groupId>org.apache.mahout</groupId>
+    <artifactId>mahout-spark_2.10</artifactId>
+    <version>${mahout.version}</version>
+</dependency>
+```
+
+####Examples
+For examples of how to use Mahout, see the examples directory located in `examples/bin`
+
+
+For information on how to contribute, visit the [How to Contribute Page](https://mahout.apache.org/developers/how-to-contribute.html)
+  
+
+####Legal
+Please see the `NOTICE.txt` included in this directory for more information.

http://git-wip-us.apache.org/repos/asf/mahout/blob/347c2f2e/README.txt
----------------------------------------------------------------------
diff --git a/README.txt b/README.txt
deleted file mode 100644
index 6a0fa99..0000000
--- a/README.txt
+++ /dev/null
@@ -1,18 +0,0 @@
-Welcome to Apache Mahout!
-
-Getting Started
-  See http://mahout.apache.org
-
-From this directory
-  To compile, do `mvn -DskipTests clean install`
-  To run tests do `mvn test`
-  To set up your IDE, do `mvn eclipse:eclipse` or `mvn idea:idea`
-
-For more information on how to contribute see:
-  https://mahout.apache.org/developers/how-to-contribute.html
-
-Legal
- Please see the NOTICE.txt included in this directory for more information.
-
-Documentation
-  See http://mahout.apache.org/