<NME> README.md
<BEF> Pyramid Machine Learning Library

[Project Homepage](https://github.com/cheng-li/pyramid)

[Project Releases](https://github.com/cheng-li/pyramid/releases)

[Project Wiki](https://github.com/cheng-li/pyramid/wiki)
_At the moment, not all algorithms are released. We are actively working on tidying up the source files and adding documentations. We will release a few algorithms at a time when they are ready and hope to have all algorthms released soon!_
## **Requirements**
If you just want to use pyramid as a command line tool (which is very simple), all you need is [Java 8](http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html).

If you are also a Java developer and wish to call Pyramid Java APIs, you will also need [Maven](https://maven.apache.org/).

## **Setup**
Pyramid doesn't require any installation effort. All you need is downloading the latest [pre-compiled package](https://github.com/cheng-li/pyramid/releases) (with a name like pyramid-x.x.x.zip) and decompressing it. Now you can move into the created folder and type 

`./pyramid config/welcome.properties`

You will see a welcome message and that means everything is working perfectly.

Windows users please see the [notes](https://github.com/cheng-li/pyramid/wiki/Notes-for-Windows-Users).
## **Command Line Usage**
All algorithms/functions implemented in Pyramid can be run though a simple command, with the following syntax:

`./pyramid <properties_file>`

Example: 

`./pyramid config/welcome.properties`

or

`./pyramid config/cbm.properties`

`pyramid` is a launcher script and `<properties_file>` is a file specifying the name of the algorithm and all necessary parameters, such as the input data, output folder, and learning algorithm hyper parameters. The `<properties_file>` can be specified by either an absolute or a relative path.

To run different algorithms, you just need to invoke the program with different properties files. The list of available algorithms and their corresponding properties file templates can be found in the [Wiki](https://github.com/cheng-li/pyramid/wiki#a-java-machine-learning-library).
 

## **Building from Source**
_If you are a Java developer who prefer working with the source code or want to contribute to the Pyramid package:_

Pyramid uses [Maven](https://maven.apache.org/) for its build system.

To compile and package the project from the source code, simply run the `mvn clean package -DskipTests` command in the cloned directory. The compressed package will be created under the core/target/releases directory.

## Feedback
We welcome your feedback on the package. To ask questions, request new features or report bugs, please contact Cheng Li  via chengli.email@gmail.com.

Answers to some commonly asked questions can be found in [FAQ](https://github.com/cheng-li/pyramid/wiki/FAQ).

<MSG> Update README.md
<DFF> @@ -1,7 +1,33 @@
 Pyramid Machine Learning Library
 
-[Project Homepage](https://github.com/cheng-li/pyramid)
+## **Requirements**
+If you just want to use pyramid as a command line tool, all you need is [Java 8](http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html).
 
-[Project Releases](https://github.com/cheng-li/pyramid/releases)
+If you are a Java developer and wish to call pyramid Java APIs, you will also need [Maven](https://maven.apache.org/).
 
-[Project Wiki](https://github.com/cheng-li/pyramid/wiki)
+## **Setup**
+Pyramid doesn't require any installation effort. You can simply download a pre-compiled package from the [project release page](https://github.com/cheng-li/pyramid/releases). Decompress the file, move into the created folder and type 
+
+`./pyramid welcome config/welcome.properties`
+
+A welcome message will show up on your screen.
+## **Command Line Usage**
+All commands are in the following format:
+
+`./pyramid <app_name> <properties_file>`
+
+The `<app_name>` is case-insensitive.
+
+The `<properties_file>` can be specified by either an absolute or a relative path.
+
+Example: 
+
+`./pyramid welcome config/welcome.properties`
+
+or
+
+`./pyramid app1 config/app1.properties`
+## **Building from Source**
+Pyramid uses [Maven](https://maven.apache.org/) for its build system.
+
+To compile and package the project, simply run the `mvn clean package -DskipTests` command in the cloned directory. The compressed package will be created under the target/releases directory. Just decompress either the .zip file or the .tar.gz file and you are done.

Update README.md