74 lines
2.3 KiB
ReStructuredText
74 lines
2.3 KiB
ReStructuredText
*****
|
|
Usage
|
|
*****
|
|
|
|
To use the C++ Format library, add :file:`format.h` and :file:`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.
|
|
Alternatively, you can :ref:`build the library with CMake <building>`.
|
|
|
|
If you are using Visual C++ with precompiled headers, you might need to add
|
|
the line ::
|
|
|
|
#include "stdafx.h"
|
|
|
|
before other includes in :file:`format.cc`.
|
|
|
|
.. _building:
|
|
|
|
Building the library
|
|
====================
|
|
|
|
The included `CMake build script`__ can be used to build the C++ Format
|
|
library on a wide range of platforms. CMake is freely available for
|
|
download from http://www.cmake.org/download/.
|
|
|
|
__ https://github.com/cppformat/cppformat/blob/master/CMakeLists.txt
|
|
|
|
CMake works by generating native makefiles or project files that can
|
|
be used in the compiler environment of your choice. The typical
|
|
workflow starts with::
|
|
|
|
mkdir build # Create a directory to hold the build output.
|
|
cd build
|
|
cmake <path/to/cppformat> # Generate native build scripts.
|
|
|
|
where :file:`{<path/to/cppformat>}` is a path to the ``cppformat`` repository.
|
|
|
|
If you are on a \*nix system, you should now see a Makefile in the
|
|
current directory. Now you can build C++ Format by running :command:`make`.
|
|
|
|
Once the library has been built you can invoke :command:`make test` to run
|
|
the tests.
|
|
|
|
If you use Windows and have Visual Studio installed, a :file:`FORMAT.sln`
|
|
file and several :file:`.vcproj` files will be created. You can then build them
|
|
using Visual Studio or msbuild.
|
|
|
|
On Mac OS X with Xcode installed, an :file:`.xcodeproj` file will be generated.
|
|
|
|
To build a `shared library`__ set the ``BUILD_SHARED_LIBS`` CMake variable to
|
|
``TRUE``::
|
|
|
|
cmake -DBUILD_SHARED_LIBS=TRUE ...
|
|
|
|
__ http://en.wikipedia.org/wiki/Library_%28computing%29#Shared_libraries
|
|
|
|
Android NDK
|
|
===========
|
|
|
|
C++ Format provides `Android.mk file`__ that can be used to build the library
|
|
with `Android NDK <https://developer.android.com/tools/sdk/ndk/index.html>`_.
|
|
For an example of using C++ Format with Android NDK, see the
|
|
`android-ndk-example <https://github.com/cppformat/android-ndk-example>`_
|
|
repository.
|
|
|
|
__ https://github.com/cppformat/cppformat/blob/master/Android.mk
|
|
|
|
Homebrew
|
|
========
|
|
|
|
C++ Format can be installed on OS X using `Homebrew <http://brew.sh/>`_::
|
|
|
|
brew install cppformat
|