update documentation

This commit is contained in:
Stani 2015-07-10 02:03:59 +02:00
parent ed5fa0e5a7
commit 990ae8fd84
2 changed files with 27 additions and 0 deletions

View file

@ -10,6 +10,8 @@ Features
Operations in draw2d include stroking and filling polygons, arcs, Bézier curves, drawing images and text rendering with truetype fonts. All drawing operations can be transformed by affine transformations (scale, rotation, translation). Operations in draw2d include stroking and filling polygons, arcs, Bézier curves, drawing images and text rendering with truetype fonts. All drawing operations can be transformed by affine transformations (scale, rotation, translation).
Package draw2d follows the conventions of the [HTML Canvas 2D Context](http://www.w3.org/TR/2dcontext/) for coordinate system, angles, etc...
Installation Installation
------------ ------------
@ -72,6 +74,19 @@ There are more examples here: https://github.com/llgcode/draw2d.samples
Drawing on opengl is provided by the draw2dgl package. Drawing on opengl is provided by the draw2dgl package.
Testing
-------
The samples are run as tests from the root package folder `draw2d` by:
```
go test ./...
```
Or if you want to run with test coverage:
```
go test -cover ./... | grep -v "no test"
```
This will generate output by the different backends in the output folder.
Acknowledgments Acknowledgments
--------------- ---------------

View file

@ -13,6 +13,8 @@
// All drawing operations can be transformed by affine transformations // All drawing operations can be transformed by affine transformations
// (scale, rotation, translation). // (scale, rotation, translation).
// //
// Package draw2d follows the conventions of http://www.w3.org/TR/2dcontext for coordinate system, angles, etc...
//
// Installation // Installation
// //
// To install or update the package draw2d on your system, run: // To install or update the package draw2d on your system, run:
@ -49,6 +51,16 @@
// Drawing on opengl is provided by the draw2dgl package. // Drawing on opengl is provided by the draw2dgl package.
// See subdirectories at the bottom of this page. // See subdirectories at the bottom of this page.
// //
// Testing
//
// The samples are run as tests from the root package folder `draw2d` by:
// go test ./...
//
// Or if you want to run with test coverage:
// go test -cover ./... | grep -v "no test"
//
// This will generate output by the different backends in the output folder.
//
// Acknowledgments // Acknowledgments
// //
// Laurent Le Goff wrote this library, inspired by Postscript and // Laurent Le Goff wrote this library, inspired by Postscript and