From 305770e4382170acb71995d125928871eecdcf29 Mon Sep 17 00:00:00 2001
From: Atsushi Watanabe <atsushi.w.roboken@gmail.com>
Date: Wed, 9 Nov 2016 13:05:46 +0900
Subject: [PATCH] adds README.md (#1)

---
 README.md | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..8c958ca
--- /dev/null
+++ b/README.md
@@ -0,0 +1,26 @@
+# ypspur-gui
+
+GUI front-end for yp-spur.
+
+## install
+
+```
+$ git clone https://github.com/at-wat/ypspur-gui.git
+$ cd ypspur-gui
+$ mkdir build
+$ cd build
+$ qmake-qt4 ../ypspur-gui.pro
+$ make
+# make install
+```
+
+## usage
+
+### Unix/Unix-like
+
+* Just run ./ypspur-gui. (ypspur-coordinator should be installed under /usr/local/bin/)
+
+### Windows
+
+* Place ypspur-gui.exe, ypspur-coordinator.exe and ypspur-interpreter.exe in the same directory.
+* Run ypspur-gui.exe.