diff options
Diffstat (limited to 'src/3rdparty/2geom/HACKING.md')
-rw-r--r-- | src/3rdparty/2geom/HACKING.md | 53 |
1 files changed, 53 insertions, 0 deletions
diff --git a/src/3rdparty/2geom/HACKING.md b/src/3rdparty/2geom/HACKING.md new file mode 100644 index 0000000..198b14a --- /dev/null +++ b/src/3rdparty/2geom/HACKING.md @@ -0,0 +1,53 @@ +# Mailing list +Communication about this project occurs on the lib2geom +[mailing list](https://lists.sourceforge.net/lists/listinfo/lib2geom-devel). + + +# Help Wanted +We greatly appreciate contributions. You don't need to be a `math-whiz` or +`über-hacker` (though these are definitely appreciated :) ) to help. The tasks +of code cleanup, consistency, testing, documentation, and toys mostly just +require perseverance, and benefit the project greatly. + +As far as very specialized skill, we are always in need of mathy people, even if +it is just for their insight on problems and techniques (as opposed to coding). + +# Coding Style +Please refer to the +[Coding Style Guidelines](http://www.inkscape.org/doc/coding_style.php) +if you have specific questions on the style to use for code. If reading style +guidelines doesn't interest you, just follow the general style of the +surrounding code, so that it is at least internally consistent. + +# Compiling +For Windows instructions, see [README.win32.md](README.win32.md) + +For Debian-like platforms, the following packages are required: + - cairo v1.1.7 or later (Debian package libcairo2-dev) + - cmake + - make + - libboost-dev + - libgsl0-dev (though eventually it will only be required in tests) + - refblas3* on dapper + +To compile, use +```bash +cmake . +Make +``` + +If you have problems, just ask on the mailing list. + +# Running tests +For Debian-like platforms, after compiling lib2geom, issue this command line +```bash +make test +``` + +# Adding a unit test +Make sure you write it using GTest syntax - look at e.g. +[src/tests/affine-test.cpp](src/tests/affine-test.cpp). + +To add the test to the build, add the test to +[src/tests/CMakeLists.txt](src/tests/CMakeLists.txt) in under +`SET(2GEOM_GTESTS_SRC)`. |