Permalink
Browse files

use markdown README.md

  • Loading branch information...
1 parent e89c56c commit 0509c6ea8215f2d797ace16ae16f93dc2e028f09 @winbomb committed Jul 11, 2012
Showing with 27 additions and 4 deletions.
  1. +0 −4 README
  2. +27 −0 README.md
View
4 README
@@ -1,4 +0,0 @@
-An Html5 Chinese classic mahjong game built with Opa(http://www.opalang.org).
-
-You can visit: http://www.gammii.com to see what it runs like.
-
View
@@ -0,0 +1,27 @@
+#Mahjong#
+
+##Overview##
+
+This is an online Chinese traditional Mahjong game in HTML5. I simplify the rule and tiles to make it easy for new
+players to begin.
+
+Mahjong is the most popular game played in China and some asian area, Mahjong is a game of skill, strategy and calculation and involves a certain degree of chance.
+
+There are many variants of Mahjong with different rules. To make it easy, this game use the most simple one. Any one who
+never touched Mahjong would learn to play it in one minutes. Besides, I redesigned some tiles to make it easy to recognize for people who don't know Chinese characters in Mahjong tiles.
+
+I have published this game on chrome web store, you can search "Mahjong Mania" to find it, or you can visit
+ [http://www.gammii.com](http://www.gammii.com) to have a quick try.
+
+##Build & Run##
+The game is built with [Opa](http://www.opalang.org), which is an enterprise framework for javascript. The source works
+fine with Opa 0.9.0 ~ 0.9.4.
+ $ make clean #optional, clean old build
+ $ make all
+ $ make run
+
+launch a browser to visit: http://localhost:8080
+
+##Contact:##
+All bug reports, feedback, comments, contributions or remarks are welcome, please email to: li.wenbo@whu.edu.cn
+

0 comments on commit 0509c6e

Please sign in to comment.