summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorTuowen Zhao <ztuowen@gmail.com>2016-09-18 15:16:52 -0600
committerTuowen Zhao <ztuowen@gmail.com>2016-09-18 15:16:52 -0600
commit18644419b50b2b14a24456e0fcdb210f231ee317 (patch)
tree3d2a57050ae93ee0ceb71df319b1533480a4001d /README.md
parent2fce43d484e4148ae858f410d51dcd9951d34374 (diff)
downloadchill-18644419b50b2b14a24456e0fcdb210f231ee317.tar.gz
chill-18644419b50b2b14a24456e0fcdb210f231ee317.tar.bz2
chill-18644419b50b2b14a24456e0fcdb210f231ee317.zip
doc updated for code_gen
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 10 insertions, 4 deletions
diff --git a/README.md b/README.md
index 91b7b0f..3cdca60 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,10 @@
-# Build
+# CHiLL
+
+***The Composable High Level Loop Source-to-Source Translator***
+
+## How to use
+
+### Build
1. build boost, rose
2. checkout repo, cd
@@ -6,13 +12,13 @@
4. `cmake --build build -- -j10`
5. If no errors during build, executables are in `build`
-# Install
+### Install
1. Optionally set `CMAKE_INSTALL_PREFIX`
2. Optionally `cmake --build build -- install`
-# Doc
+## Additional Doc
* CHiLL.pdf
-* `cmake --build build -- doc`
+* Doxygen: `cmake --build build -- doc`