From 990ae8fd84722ad45ded53231e5383d548e7c932 Mon Sep 17 00:00:00 2001 From: Stani Date: Fri, 10 Jul 2015 02:03:59 +0200 Subject: [PATCH] update documentation --- README.md | 15 +++++++++++++++ draw2d.go | 12 ++++++++++++ 2 files changed, 27 insertions(+) diff --git a/README.md b/README.md index c9aca0c..d747d15 100644 --- a/README.md +++ b/README.md @@ -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). +Package draw2d follows the conventions of the [HTML Canvas 2D Context](http://www.w3.org/TR/2dcontext/) for coordinate system, angles, etc... + 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. +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 --------------- diff --git a/draw2d.go b/draw2d.go index 3711927..79a5a0a 100644 --- a/draw2d.go +++ b/draw2d.go @@ -13,6 +13,8 @@ // All drawing operations can be transformed by affine transformations // (scale, rotation, translation). // +// Package draw2d follows the conventions of http://www.w3.org/TR/2dcontext for coordinate system, angles, etc... +// // Installation // // To install or update the package draw2d on your system, run: @@ -49,6 +51,16 @@ // Drawing on opengl is provided by the draw2dgl package. // 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 // // Laurent Le Goff wrote this library, inspired by Postscript and