From 29efaaad31f4c6a25df2f735de465a461e132c2c Mon Sep 17 00:00:00 2001 From: lbartoletti Date: Tue, 4 Jun 2024 08:53:16 +0000 Subject: [PATCH] Update README.md --- README.md | 69 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 69 insertions(+) diff --git a/README.md b/README.md index 84f7b838..c43dd97c 100644 --- a/README.md +++ b/README.md @@ -10,8 +10,77 @@ Please refer to the project page fo [![Packaging status](https://repology.org/badge/vertical-allrepos/sfcgal.svg)](https://repology.org/project/sfcgal/versions) +## Community Resources + +* Website: https://sfcgal.org +* **git** repository: https://gitlab.com/sfcgal/SFCGAL +* **#sfcgal** chat channel (all bridged): + * IRC: irc://irc.libera.chat/#sfcgal (https://kiwiirc.com/nextclient/irc.libera.chat/#sfcgal) + +## Build/Install + +See the [INSTALL](https://sfcgal.gitlab.io/SFCGAL/installation.html) page. + +## Reference Docs + +* [C API](https://sfcgal.gitlab.io/SFCGAL/doxygen/group__capi.html) +* [C++ API](https://sfcgal.gitlab.io/SFCGAL/doxygen/group__public__api.html) + +## Client Applications + +### Using the C interface + +SFCGAL promises long-term stability of the C API. In general, successive releases +of the C API may add new functions but will not remove or change existing types +or function signatures. The C library uses the C++ interface, but the C library +follows normal ABI-change-sensitive versioning, so programs that link only +against the C library should work without relinking when SFCGAL is upgraded. For +this reason, it is recommended to use the C API for software that is intended +to be dynamically linked to a system install of SFCGAL. + +The `sfcgal-config` program can be used to determine appropriate compiler and +linker flags for building against the C library: + + CFLAGS += `sfcgal-config --cflags` + LDFLAGS += `sfcgal-config --ldflags --libs` + +All functionality of the C API is available through the `sfcgal_c.h` header file. + +Documentation for the C API is provided via comments in the `sfcgal_c.h` header +file. C API usage examples can be found in the SFCGAL unit tests and in the +source code of software that uses SFCGAL, such as PostGIS and the PySFCGAL package +for Python. + +### Using other languages + +SFCGAL has bindings in many languages, see the [bindings +page](https://sfcgal.gitlab.io/SFCGAL/dev.html). + + +## Documentation + +API documentation can be generated using Doxygen. Documentation is not included +in the default build. To build the documentation see the [dev](https://sfcgal.gitlab.io/SFCGAL/dev.html) page. + + +## Style + +To format your code into the desired style, use the clang-format tools. + + +## Testing + +See documentation in [dev](https://sfcgal.gitlab.io/SFCGAL/dev.html) page. + +## Tools + +* `geosop` - a CLI for GEOS. Documentation is in [util/geosop/README.md](util/geosop/README.md). ## Licence SFCGAL is provided under the following licence LGPL version 2 or later. :warning: Note that the main dependency for SFCGAL is the CGAL library, and SFCGAL uses CGAL modules which are licenced as GPLv3+. Whenever you compile and distribute SFCGAL with the GPL-licenced CGAL, the full packaged result is automatically considered as GPL version 3 or later, due to GPL "viral" property. **If you link and distribute SFCGAL with another software package, be assured to fully understand the implications and check any legal and technical requirements implied by the licence**. + +## Bindings + +S \ No newline at end of file