build/example/hello/readme.adoc
Rene Rivera 950e884618 Slight cleanup of hello example.
Change hello example docs to not rely on having sources around. Instead
it now inline the source to make it possible to have a truly standalone
doc.
2018-01-22 09:45:02 -06:00

47 lines
1.0 KiB
Plaintext

////
Copyright 2008 Jurko Gospodnetic
Copyright 2017 Rene Rivera
Distributed under the Boost Software License, Version 1.0.
(See accompanying file LICENSE_1_0.txt or http://www.boost.org/LICENSE_1_0.txt)
////
= Hello
This example shows a very basic Boost Build project set up so it compiles a
single executable from a single source file:
.`hello.cpp`
[source,cpp]
----
include::../../example/hello/hello.cpp[tag=source]
----
Our `jamroot.jam` is minimal and only specifies one `exe` target for the
program:
.`jamroot.jam`
[source,jam]
----
include::jamroot.jam[]
----
Building the example yields:
[source,bash]
----
> cd /example/hello
> b2
...found 8 targets...
...updating 4 targets...
common.mkdir bin/clang-darwin-4.2.1
common.mkdir bin/clang-darwin-4.2.1/debug
clang-darwin.compile.c++ bin/clang-darwin-4.2.1/debug/hello.o
clang-darwin.link bin/clang-darwin-4.2.1/debug/hello
...updated 4 targets...
> bin/clang-darwin-4.2.1/debug/hello
Hello!
----
NOTE: The actual paths in the `bin` sub-directory will depend on your
toolset.