Re: [jamboost] [BBv2 doc editorial] Tutorial

From: Vladimir Prus (ghost_at_[hidden])
Date: 2005-09-21 09:30:22

On Wednesday 21 September 2005 00:55, Andrey Melnikov wrote:

> >>Project Hierarchies
> >>Dependent Targets
> >>Static and shared libaries
> >>Conditions and alternatives
> >>Prebuilt targets
>
> The table of contents looks cryptic for a new user. The terms are used
> before they are defined:
> - BB project
> - Jam language
> - build variants
> - build targets

Take a look at documentation structure proposal I've just posted.

> The examples don't demonstrate the key BB features and don't have a big
> practical usage for a newbie.

In fact, they was not meant to demonstrate everything. IMO, tutorial should 
guide though basic tasks in a project (building, testing, installing) so that
user gets familiar with the tool.

> Look at my Getting Started Guide: http://tinyurl.com/bcgwf
> It isn't perfect, but I think some ideas can be taken from there.

I think those key advanges section complements, but does not override, the 
tutorial. Users to need a simple self-contained and very commented examples.
And as you say yourself:

> The sections are for managers and their goal is to help them to evaluate 
> pros and cons quickly and to sell the idea to use Boost.Build to the 
> team and to the top management.

- Volodya

-- 
Vladimir Prus
http://vladimir_prus.blogspot.com
Boost.Build V2: http://boost.org/boost-build2