/Src/Dependencies/Boost/more/getting_started/index.rst

http://hadesmem.googlecode.com/ · ReStructuredText · 70 lines · 49 code · 21 blank · 0 comment · 0 complexity · 8a0252c413d1f2989376e20a6569f4a5 MD5 · raw file

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