Permalink
Browse files

Add documentations

  • Loading branch information...
1 parent 867ec43 commit 266789ef89a971fc72bcf29544c12953f0c51629 @xerial xerial committed Sep 10, 2013
Showing with 31 additions and 1 deletion.
  1. +13 −0 README.md
  2. +18 −1 development.md
View
@@ -0,0 +1,13 @@
+# UTGB - The University of Tokyo Genome Browser
+
+UTGB (University of Tokyo Genome Browser) is an open-source software for
+browsing biological data mapped onto a genome sequence in standard web
+browsers (e.g., Chrome, Firefox, Safari, etc.).
+
+UTGB Toolkit has the following features:
+ * ***Interactive web interface***. UTGB uses AJAX-based web interfaces to avoid excessive reloading of web pages.
+ * ***Easy installation***. UTGB is already equipped with a stand-alone web server and database management system, which will be used for querying genome databases. No need exists to set up these complicated system programs after installing UTGB.
+ * ***Portablility***. The generated genome browsers work in Windows, Mac and Linux, and can be used as stand-alone applications in your computers. It is also possible to deploy your genome browsers to remote web servers.
+
+The UTGB is licensed under an [license.html open source license], and is freely available for both commercial and personal use.
+
View
@@ -42,7 +42,24 @@
You also need to copy bookmarklet from http://192.xx.xx.xx:9876 since it becomes different from when using http://localhost:9876
-* Install utgb command
+### Install utgb command
$ make install
+### Run tests
+
+ $ ./sbt test -Dloglevel=debug
+
+### Run tests when updates of source codes are detected
+
+ $ ./sbt "~test" -Dloglevel=debug
+
+### Run specific tests matching a pattern
+
+ $ ./sbt "~test-only *HelloTest" -Dloglevel=debug
+
+### Run tagged test only
+
+ $ ./sbt "~test -- -n test1" -Dloglevel=debug
+
+

0 comments on commit 266789e

Please sign in to comment.