more/getting_started/index.rst

   1 .. Copyright David Abrahams 2006. Distributed under the Boost
   2 .. Software License, Version 1.0. (See accompanying
   3 .. file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
   4
   5 ============================
   6  |(logo)|__ Getting Started
   7 ============================
   8
   9 .. |(logo)| image:: ../../boost.png
  10    :alt: Boost
  11    :class: boost-logo
  12
  13 __ ../../index.htm
  14
  15 .. Admonition:: Use the latest version of this Getting Started guide
  16
  17   The `Boost website version of this Getting Started guide`_ may
  18   have undated information, such as the location of additional installers
  19   or improved installation procedures, so you might want use that version
  20   if you've got an Internet connection available.
  21
  22   .. _`Boost website version of this Getting Started guide`:
  23        http://www.boost.org/doc/libs/release/more/getting_started/index.html
  24
  25 Welcome
  26 -------
  27
  28 Welcome to the Boost libraries!  By the time you've completed this
  29 tutorial, you'll be at least somewhat comfortable with the contents
  30 of a Boost distribution and how to go about using it.
  31
  32 What's Here
  33 -----------
  34
  35 This document is designed to be an *extremely* gentle introduction,
  36 so we included a fair amount of material that may already be very
  37 familiar to you.  To keep things simple, we also left out some
  38 information intermediate and advanced users will probably want.  At
  39 the end of this document, we'll refer you on to resources that can
  40 help you pursue these topics further.
  41
  42 Preliminaries
  43 -------------
  44
  45 We use one typographic convention that might not be immediately
  46 obvious: *italic* text in examples is meant as a descriptive
  47 placeholder for something else, usually information that you'll
  48 provide.  For example:
  49
  50 .. parsed-literal::
  51
  52    **$** echo "My name is *your name*\ "
  53
  54 Here you're expected to imagine replacing the text “your name” with
  55 your actual name.
  56
  57 Ready?
  58 ------
  59
  60 Let's go!
  61
  62 .. footer::
  63   .. class:: nextpage
  64
  65      | **Next:** `Getting Started on Microsoft Windows`__
  66      | **or:** `Getting Started on Unix variants (e.g. Linux, MacOS)`__
  67
  68 __ windows.html
  69 __ unix-variants.html
  70