Skip to content

Adding explanation about BG examples in README and quick start #1462

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
vissarion merged 1 commit into from
May 7, 2026
+6 −2
Merged

Adding explanation about BG examples in README and quick start #1462

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ Boost.Geometry, part of collection of the [Boost C++ Libraries](http://github.co

### Directories

* **doc** - QuickBook documentation sources
* **example** - Boost.Geometry examples
* **doc** - QuickBook documentation sources, containing embedded examples located in `doc/src/examples/`
* **example** - Boost.Geometry standalone examples
* **_extensions_** - examples and tests for the extensions - _develop branch_
* **include** - the sourcecode of Boost.Geometry
* **index** - examples and tests for the Spatial Index
Expand Down
4 changes: 4 additions & 0 deletions doc/quickstart.qbk
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,10 @@
This Quick Start section shows some of the features of __boost_geometry__
in the form of annotated, relatively simple, code snippets.

For longer standalone tutorial-style programs, see the repository's `example/` directory;
for smaller reference-oriented snippets used throughout the manual,
see `doc/src/examples/`.

The code below assumes that `boost/geometry.hpp` is included, and that `namespace
boost::geometry` is used. __boost_geometry__ is header only, so including
headerfiles is enough. There is no linking with any library necessary.
Expand Down
Loading