diff --git a/README.md b/README.md index 9613684618..32547e9a02 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/doc/quickstart.qbk b/doc/quickstart.qbk index c794e4f9c9..0316fea12c 100644 --- a/doc/quickstart.qbk +++ b/doc/quickstart.qbk @@ -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.