OSDN Git Service

add How to Install to README
authorSet <set.minami@gmail.com>
Thu, 8 Aug 2013 13:40:53 +0000 (22:40 +0900)
committerSet <set.minami@gmail.com>
Thu, 8 Aug 2013 13:40:53 +0000 (22:40 +0900)
README.md

index 7f737da..5b32d5e 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,6 +1,18 @@
 ![BlackQuill](./BlackQuill.png)
-<h1>BlackQuill is Coming Soon...</h>
+<h1>BlackQuill 0.1.2 released</h>
 <br />
 <br />
-<br />
-![planAndProceed](./planAndproceed.png)
+BlackQuill is an advanced markdown engine.
+# How to Install
+Step 1. Setup sbt [see](http://www.scala-sbt.org/release/docs/Getting-Started/Setup.html)
+Step 2. Clone BlackQuill sbt project
+    git clone https://github.com/setminami/BlackQuill.git /path/to/yourlocal/directory
+Step 3. cd your local BlackQuill project directory and run an simple installer
+    $cd /path/to/yourlocal/directory
+    $./build.sh
+Step 4. Copy the BlackQuill to you PATH
+    $sudo cp ./BlackQuill /path/to/can/execute/.
+
+OK, you can use BlackQuill.
+e.g.,)
+    $BlackQuill --help
\ No newline at end of file