add readme

2014-12-27 11:30:20 +08:00 · 2014-12-27 11:30:20 +08:00 · ecc73b5c76
parent 7da0f0e831
commit ecc73b5c76
1 changed files with 77 additions and 1 deletions
--- a/README.md
+++ b/README.md
@ -1,4 +1,80 @@
 gochart
 =======

-An chart plot tool implemented by golang
+gochart仿照[goplot](https://github.com/skoo87/goplot)使用golang和[highcharts](http://www.highcharts.com)开源库制作的，是一个使用简单的绘制图表的工具，图表风格有曲线图、折线图、面积图、柱状图、饼图等。编译好的gochart只有一个二进制文件，不依赖任何库/网络。
+
+##### 下 载
+
+[Mac OS X](http://www.bigendian123.com/gochart-darwin.tar.gz)
+
+[Linux amd64](http://www.bigendian123.com/gochart-linux-amd64.tar.gz)
+
+[Win7 amd64](download/bin/gochart.exe)
+
+##### 使用方法
+
+* 解压下载包后，进入解压目录，可以看到一个gochart的可执行文件和一些*.chart文件，这些chart文件是默认的一些数据文件样例。可以在这些chart文件的目录执行gochart，然后通过浏览器访问http://localhost:8000就可以看到图表了。
+* 你可以把`gochart`工具放到你的`PATH`中，在chart文件所在的目录执行gochart即可。
+* chart文件必须是.chart后缀名，内容可以参考源码examples目录中的例子。启动gochart的目录如果有多个chart文件，可以通过不断刷新网页来切换图表。
+
+##### 曲线图数据格式示例1
+
+    # The chart type , option : spline/line/bar/column/area
+    ChartType = spline
+    Title = Source: WorldClimate.com
+    SubTitle = Monthly Average Temperature
+    ValueSuffix = °C
+    
+    # The x Axis numbers. The count this numbers MUST be the same with the data series
+    XAxisNumbers = 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12
+    
+    # The y Axis text
+    YAxisText = Temperature (°C)
+    
+    # The data and the name of the lines
+    Data|Tokyo = 7.0, 6.9, 9.5, 14.5, 18.2, 21.5, 25.2, 26.5, 23.3, 18.3, 13.9, 9.6
+    Data|New York = -0.2, 0.8, 5.7, 11.3, 17.0, 22.0, 24.8, 24.1, 20.1, 14.1, 8.6, 2.5
+    Data|Berlin = -0.9, 0.6, 3.5, 8.4, 13.5, 17.0, 18.6, 17.9, 14.3, 9.0, 3.9, 1.0
+    Data|London = 3.9, 4.2, 5.7, 8.5, 11.9, 15.2, 17.0, 16.6, 14.2, 10.3, 6.6, 4.8
+   
+该示例数据格式与曲线图、折线图、面积图、(横向/纵向)柱状图通用。通过改变`ChartType`可以展现不同类型的图，如下：
+- spline 曲线图
+- line 折线图
+- bar 横向柱状图
+- column 纵向柱状图
+- area 面积图
+
+##### 曲线图数据格式示例2
+
+    ChartType  = pie
+    Title 	   = Browser market shares at a specific website, 2014
+    SubTitle   = from website.com
+    SeriesName = Browser shares
+    
+    # The data and the name of the pieces of the pie 
+    Data|Firefox = 45.0
+    Data|IE 	 = 26.8
+    Data|Chrome  = 12.8
+    Data|Safari  = 8.5
+    Data|Opera   = 6.2
+    Data|Others  = 0.7    
+
+该示例数据格式展示了如何绘制一个饼图。
+
+##### 曲线图
+![](image/spline.png)
+
+##### 折线图
+![](image/line.png)
+
+##### 纵向柱状图
+![](image/column.png)
+
+##### 横向柱状图
+![](image/bar.png)
+
+##### 面积图
+![](image/area.png)
+
+##### 饼图
+![](image/pie.png)