README.md
1# Libboard: a vector graphics C++ library
2
3<img src="https://foureys.users.greyc.fr/board/doc/LibBoardLogoII_Small.png">
4
5## The LibBoard C++ library
6
7#### Purpose
8
9The LibBoard C++ library allows the drawing of Postscript, SVG, and FIG (XFig)
10vector graphics using the C++ programming language.
11
12It is suitable for adding SVG/EPS/FIG output support to a program; but also for
13drawing graphics that involve a large (huge?) number of primitives. In the
14latter case, one can indeed use loops, variables, functions and all C++
15features. Produced files may afterwards be edited using dedicated tools.
16
17### Features
18
19
20For now, LibBoard can handle primitives like lines, rectangles, triangles, polylines, circles, ellipses, bitmap images and text. See the [TODO](TODO) file for a list of features that should be added in future releases.
21
22### Documentation
23
24 * See the Doxygen-made [documentation](https://foureys.users.greyc.fr/board/doc/0.9.4/).
25
26 * [Sample codes](EXAMPLES.md) with their output.
27
28### Licence
29
30Starting with version 0.9.0, LibBoard is distributed under the term of the [GNU Lesser General Public License](LICENSE).
31
32#### Citing LibBoard
33
34LibBoard: A vector graphics C++ library (Version 0.9.4). GREYC laboratory. [Software]. https://github.com/c-koi/libboard. [accessed Sept. 2015].
35```
36 @misc{LibBoard,
37 key = {{LibBoard}},
38 title = {{LibBoard: A vector graphics C++ library (Version 0.9.4). [Software]. GREYC Laboratory}},
39 howpublished = {{https://github.com/c-koi/libboard}},
40 note = {{[accessed June 2016]}},
41 year = {2016},
42 }
43```
44### Download
45
46 * You may get the lastest source code from the Git repository with the command below:
47
48```
49 git clone https://github.com/c-koi/libboard.git
50```
51
52 * You may also consider [downloading an archive of the latest stable release](https://github.com/c-koi/libboard/releases/tag/v0.9.4).
53
54### Author
55
56 * S�bastien Fourey (foureys.users.greyc.fr).
57
