Move Usage section to a separate file

This commit is contained in:
Victor Zverovich 2014-10-16 07:12:43 -07:00
parent 2b17d47372
commit 32392597aa
2 changed files with 19 additions and 17 deletions

View File

@ -2,25 +2,9 @@
C++ Format C++ Format
########## ##########
*****
Usage
*****
To use the C++ Format library, add ``format.h`` and ``format.cc`` from
a `release archive <https://github.com/cppformat/cppformat/releases/latest>`_
or the `Git repository <https://github.com/cppformat/cppformat>`_ to your project.
If you are using Visual C++ with precompiled headers, you might need to add
the line
::
#include "stdafx.h"
before other includes in ``format.cc``.
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
usage
reference reference
syntax syntax

18
doc/usage.rst Normal file
View File

@ -0,0 +1,18 @@
.. highlight:: c++
*****
Usage
*****
To use the C++ Format library, add ``format.h`` and ``format.cc`` from
a `release archive <https://github.com/cppformat/cppformat/releases/latest>`_
or the `Git repository <https://github.com/cppformat/cppformat>`_ to your project.
If you are using Visual C++ with precompiled headers, you might need to add
the line
::
#include "stdafx.h"
before other includes in ``format.cc``.