adds README.md (#1)

openspur · Nov 9, 2016 · 305770e · 305770e
1 parent be7a4e9
commit 305770e
Showing 1 changed file with 26 additions and 0 deletions.
diff --git a/README.md 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.