1# Mailing list
2Communication about this project occurs on the lib2geom
3[mailing list](https://lists.sourceforge.net/lists/listinfo/lib2geom-devel).
4
5
6# Help Wanted
7We greatly appreciate contributions.  You don't need to be a `math-whiz` or
8`über-hacker` (though these are definitely appreciated :) ) to help.  The tasks
9of code cleanup, consistency, testing, documentation, and toys mostly just
10require perseverance, and benefit the project greatly.
11
12As far as very specialized skill, we are always in need of mathy people, even if
13it is just for their insight on problems and techniques (as opposed to coding).
14
15# Coding Style
16Please refer to the
17[Coding Style Guidelines](http://www.inkscape.org/doc/coding_style.php)
18if you have specific questions on the style to use for code. If reading style
19guidelines doesn't interest you, just follow the general style of the
20surrounding code, so that it is at least internally consistent.
21
22# Compiling
23For Windows instructions, see [README.win32.md](README.win32.md)
24
25For Debian-like platforms, the following packages are required:
26 - cairo v1.1.7 or later (Debian package libcairo2-dev)
27 - cmake
28 - make
29 - libboost-dev
30 - libgsl0-dev (though eventually it will only be required in tests)
31 - refblas3* on dapper
32
33To compile, use
34```bash
35cmake .
36Make
37```
38
39If you have problems, just ask on the mailing list.
40
41# Running tests
42For Debian-like platforms, after compiling lib2geom, issue this command line
43```bash
44make test
45```
46
47# Adding a unit test
48Make sure you write it using GTest syntax - look at e.g.
49[src/tests/affine-test.cpp](src/tests/affine-test.cpp).
50
51To add the test to the build, add the test to
52[src/tests/CMakeLists.txt](src/tests/CMakeLists.txt) in under
53`SET(2GEOM_GTESTS_SRC)`.
54