Skip to content

Commit

Permalink
update(docs): sanitize README
Browse files Browse the repository at this point in the history
  • Loading branch information
Guts committed Nov 15, 2024
1 parent 98d0e1e commit 4f08ffb
Showing 1 changed file with 3 additions and 6 deletions.
9 changes: 3 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,10 @@ Please refer to the <a href="http://sfcgal.gitlab.io/SFCGAL">project page</a> fo

## Community Resources

* Website: https://sfcgal.org
* **git** repository: https://gitlab.com/sfcgal/SFCGAL
* 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)
* IRC: irc://irc.libera.chat/#sfcgal (<https://kiwiirc.com/nextclient/irc.libera.chat/#sfcgal>)

## Build/Install

Expand Down Expand Up @@ -55,13 +55,11 @@ for Python.

SFCGAL has bindings in many languages, see the [bindings page](https://sfcgal.gitlab.io/SFCGAL/development/#bindings).


## Documentation

API documentation can be generated using Doxygen. Documentation is not included
in the default build. To build the documentation see the [Development](https://sfcgal.gitlab.io/SFCGAL/development/) page.


## Style

To format your code into the desired style, use the `clang-format` tools.
Expand All @@ -74,7 +72,6 @@ pre-commit install

To commit without the *git hooks*, add the `--no-verify` option to the `git commit` command.


## Testing

See documentation in [Development](https://sfcgal.gitlab.io/SFCGAL/development/) page.
Expand Down

0 comments on commit 4f08ffb

Please sign in to comment.