Add new README.

ccopsey · Jun 9, 2015 · 49d0466 · 49d0466
1 parent 9e8f715
commit 49d0466
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 4 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -20,7 +20,3 @@ before_script:
 
 script:
   - cmake . && make
-
-matrix:
-  allow_failures:
-    - compiler: clang
diff --git a/README.md b/README.md
@@ -0,0 +1,16 @@
+# ParMGridGen [![Build Status](https://travis-ci.org/ccopsey/ParMGridGen.svg?branch=master)](https://travis-ci.org/ccopsey/ParMGridGen)
+
+This is a fork of ParMGridGen(http://www-users.cs.umn.edu/~moulitsa/software.html) with CMake build system.
+
+To build ParMGridGen:
+
+  1. Download or clone the sources from `http://github.com/ccopsey/ParMGridGen`
+  2. `cd` into `ParMGridGen`
+  3. `cmake .`
+  4. `make install`
+
+To build individual components of the library, for example only `mgridgen`, use:
+
+  `make mgridgen install`
+
+Advanced options are available via CMake.