Skip to content

Commit aed7bc3

Browse files
authored
Merge pull request #1462 from boostorg/readme_examples_addition
Adding explanation about BG examples in README and quick start
2 parents be42840 + f8281fb commit aed7bc3

2 files changed

Lines changed: 6 additions & 2 deletions

File tree

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ Boost.Geometry, part of collection of the [Boost C++ Libraries](http://github.co
1717

1818
### Directories
1919

20-
* **doc** - QuickBook documentation sources
21-
* **example** - Boost.Geometry examples
20+
* **doc** - QuickBook documentation sources, containing embedded examples located in `doc/src/examples/`
21+
* **example** - Boost.Geometry standalone examples
2222
* **_extensions_** - examples and tests for the extensions - _develop branch_
2323
* **include** - the sourcecode of Boost.Geometry
2424
* **index** - examples and tests for the Spatial Index

doc/quickstart.qbk

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,10 @@
1515
This Quick Start section shows some of the features of __boost_geometry__
1616
in the form of annotated, relatively simple, code snippets.
1717

18+
For longer standalone tutorial-style programs, see the repository's `example/` directory;
19+
for smaller reference-oriented snippets used throughout the manual,
20+
see `doc/src/examples/`.
21+
1822
The code below assumes that `boost/geometry.hpp` is included, and that `namespace
1923
boost::geometry` is used. __boost_geometry__ is header only, so including
2024
headerfiles is enough. There is no linking with any library necessary.

0 commit comments

Comments
 (0)