summaryrefslogtreecommitdiff
path: root/libs/python/example/README
diff options
context:
space:
mode:
Diffstat (limited to 'libs/python/example/README')
-rw-r--r--libs/python/example/README16
1 files changed, 16 insertions, 0 deletions
diff --git a/libs/python/example/README b/libs/python/example/README
new file mode 100644
index 000000000..29a94f67d
--- /dev/null
+++ b/libs/python/example/README
@@ -0,0 +1,16 @@
+.. Copyright David Abrahams 2006. Distributed under the Boost
+.. Software License, Version 1.0. (See accompanying
+.. file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+
+To get started with the Boost Python Library, use the examples
+getting_started1.cpp and getting_started2.cpp. Invoking
+
+ bjam --toolset=your-toolset test
+
+in this directory will build and run the examples. See
+http://www.boost.org/more/getting_started.html for details about the
+--toolset= option.
+
+If you move this example from its place in the Boost development tree
+you'll need to edit the two lines indicated in Jamroot and
+boost-build.jam.