diff --git a/README.md b/README.md index e55baf2..dd38189 100644 --- a/README.md +++ b/README.md @@ -1,37 +1,33 @@ draw2d ====== -This package (written in [go](http://golang.org)) provides an API to draw 2d geometrical forms on [images](http://golang.org/pkg/image). -This library is largely inspired by [postscript](http://www.tailrecursive.org/postscript), [cairo](http://cairographics.org) and [HTML5 canvas](http://dev.w3.org/html5/canvas-api/canvas-2d-api.html#the-2d-drawing-context). +This package (written in [go](http://golang.org)) provides an API to draw 2d vector forms on [images](http://golang.org/pkg/image). +This library is inspired by [postscript](http://www.tailrecursive.org/postscript) and [HTML5 canvas](http://www.w3.org/TR/2dcontext/). The package depends on [freetype-go](http://code.google.com/p/freetype-go) package for its rasterization algorithm. -Some algorithms have been translated from the [antigrain.com](http://www.antigrain.com) project ([adaptive bezier](http://www.antigrain.com/research/adaptive_bezier/index.html), and arc drawing.) -## Installation -Once you have Go installed, to install `draw2d`: +Using +----- + +Install [golang](http://golang.org) and get `draw2d` ```sh -$ go get github.com/llgcode/draw2d +go get github.com/llgcode/draw2d ``` -a good starting point is the [getting started](http://github.com/llgcode/draw2d/wiki/GettingStarted) wiki page. +and start coding using one of the samples here. +Some usages of draw2d [Samples](https://github.com/llgcode/draw2d.samples) -## [Samples](http://github.com/llgcode/draw2d/wiki/Samples) -[Sample](https://github.com/llgcode/draw2d/wiki/Samples) images generated by `draw2d` (inspired by [cairo samples](http://cairographics.org/samples): +Known Software or Packages using draw2d +--------------------------------------- -If you find bugs, please refer to the [issue tracker](http://github.com/llgcode/draw2d/issues). + - [golang postscript interpreter](https://github.com/llgcode/ps) + - [golang postscript interpreter](https://github.com/gonum/plot) -![Path](https://github.com/llgcode/draw2d/raw/wiki/test_results/TestPath.png) -![DrawArc](https://github.com/llgcode/draw2d/raw/wiki/test_results/TestDrawArc.png) -![DrawArcNegative](https://github.com/llgcode/draw2d/raw/wiki/test_results/TestDrawArcNegative.png) -![CurveRectangle](https://github.com/llgcode/draw2d/raw/wiki/test_results/TestCurveRectangle.png) -![DrawCubicCurve](https://github.com/llgcode/draw2d/raw/wiki/test_results/TestDrawCubicCurve.png) -![Dash](https://github.com/llgcode/draw2d/raw/wiki/test_results/TestDash.png) -![FillStroke](https://github.com/llgcode/draw2d/raw/wiki/test_results/TestFillStroke.png) -![FillStyle](https://github.com/llgcode/draw2d/raw/wiki/test_results/TestFillStyle.png) -![MultiSegmentCaps](https://github.com/llgcode/draw2d/raw/wiki/test_results/TestMultiSegmentCaps.png) -![RoundRectangle](https://github.com/llgcode/draw2d/raw/wiki/test_results/TestRoundRectangle.png) -![LineCap](https://github.com/llgcode/draw2d/raw/wiki/test_results/TestLineCap.png) -![LineJoin](https://github.com/llgcode/draw2d/raw/wiki/test_results/TestLineJoin.png) +Reference +--------- + + - [antigrain.com](http://www.antigrain.com) + - [freetype-go](http://code.google.com/p/freetype-go)