mirror/fmt
1
0
Fork 0
mirror of https://github.com/fmtlib/fmt.git synced 2024-12-24 03:17:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update docs

Browse Source
This commit is contained in:
Victor Zverovich 2016-04-27 08:35:59 -07:00
parent f9ee5f4b43
commit c916ab3319
4 changed files with 29 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
doc/_templates/layout.html vendored
View File

@ -42,7 +42,7 @@
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="index.html">C++ Format</a>
<a class="navbar-brand" href="index.html">{fmt}</a>
</div>
{# Collect the nav links, forms, and other content for toggling #}
@ -77,18 +77,18 @@
{% if pagename == "index" %}
<div class="jumbotron">
<div class="tb-container">
<h1>C++ Format</h1>
<h1>{fmt}</h1>
<p class="lead">Small, safe and fast formatting library for C++</p>
<div class="btn-group" role="group">
<a class="btn btn-success"
href="https://github.com/cppformat/cppformat/releases/download/2.0.0/cppformat-2.0.0.zip">
href="https://github.com/fmtlib/fmt/releases/download/2.0.0/cppformat-2.0.0.zip">
<span class="glyphicon glyphicon-download"></span> Download
</a>
<button type="button" class="btn btn-success dropdown-toggle" data-toggle="dropdown"><span class="caret"></span></button>
<ul class="dropdown-menu">
<li><a href="https://github.com/cppformat/cppformat/releases/download/2.0.0/cppformat-2.0.0.zip">Version 2.0.0</a></li>
<li><a href="https://github.com/cppformat/cppformat/releases/download/1.1.0/cppformat-1.1.0.zip">Version 1.1.0</a></li>
<li><a href="https://github.com/cppformat/cppformat/releases/download/1.0.0/cppformat-1.0.0.zip">Version 1.0.0</a></li>
<li><a href="https://github.com/fmtlib/fmt/releases/download/2.0.0/cppformat-2.0.0.zip">Version 2.0.0</a></li>
<li><a href="https://github.com/fmtlib/fmt/releases/download/1.1.0/cppformat-1.1.0.zip">Version 1.1.0</a></li>
<li><a href="https://github.com/fmtlib/fmt/releases/download/1.0.0/cppformat-1.0.0.zip">Version 1.0.0</a></li>
</ul>
</div>
</div>

4
doc/api.rst
View File

@ -4,7 +4,7 @@
API Reference
*************
All functions and classes provided by the C++ Format library reside
All functions and classes provided by the fmt library reside
in namespace ``fmt`` and macros have prefix ``FMT_``. For brevity the
namespace is usually omitted in examples.
@ -126,7 +126,7 @@ System errors
Custom allocators
=================
The C++ Format library supports custom dynamic memory allocators.
The fmt library supports custom dynamic memory allocators.
A custom allocator class can be specified as a template argument to
:class:`fmt::BasicMemoryWriter`::

14
doc/index.rst
View File

@ -1,9 +1,9 @@
Overview
========
C++ Format (cppformat) is an open-source formatting library for C++.
**fmt** (previously cppformat) is an open-source formatting library.
It can be used as a safe alternative to printf or as a fast
alternative to IOStreams.
alternative to C++ IOStreams.
.. raw:: html
@ -146,7 +146,7 @@ is represented by ``L'\x42e'`` if we use Unicode) which is rarely what is needed
Portability
-----------
C++ Format is highly portable. Here is an incomplete list of operating systems and
The library is highly portable. Here is an incomplete list of operating systems and
compilers where it has been tested and known to work:
* 64-bit (amd64) GNU/Linux with GCC 4.4.3, `4.6.3 <https://travis-ci.org/cppformat/cppformat>`_,
@ -188,16 +188,16 @@ always prints ``inf``.
Ease of Use
-----------
C++ Format has small self-contained code base consisting of a single header file
fmt has a small self-contained code base consisting of a single header file
and a single source file and no external dependencies. A permissive BSD `license
<https://github.com/cppformat/cppformat#license>`_ allows using the library both
<https://github.com/fmtlib/fmt#license>`_ allows using the library both
in open-source and commercial projects.
.. raw:: html
<a class="btn btn-success" href="https://github.com/cppformat/cppformat">GitHub Repository</a>
<a class="btn btn-success" href="https://github.com/fmtlib/fmt">GitHub Repository</a>
<div class="section footer">
<iframe src="http://ghbtns.com/github-btn.html?user=cppformat&amp;repo=cppformat&amp;type=watch&amp;count=true"
<iframe src="http://ghbtns.com/github-btn.html?user=fmtlib&amp;repo=fmt&amp;type=watch&amp;count=true"
class="github-btn" width="100" height="20"></iframe>
</div>

28
doc/usage.rst
View File

@ -2,9 +2,9 @@
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.
To use the fmt library, add :file:`format.h` and :file:`format.cc` from
a `release archive <https://github.com/fmtlib/fmt/releases/latest>`_
or the `Git repository <https://github.com/fmtlib/fmt>`_ 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
@ -19,24 +19,24 @@ before other includes in :file:`format.cc`.
Building the library
====================
The included `CMake build script`__ can be used to build the C++ Format
The included `CMake build script`__ can be used to build the fmt
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
__ https://github.com/fmtlib/fmt/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.
mkdir build # Create a directory to hold the build output.
cd build
cmake <path/to/cppformat> # Generate native build scripts.
cmake <path/to/fmt> # Generate native build scripts.
where :file:`{<path/to/cppformat>}` is a path to the ``cppformat`` repository.
where :file:`{<path/to/fmt>}` is a path to the ``fmt`` 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`.
current directory. Now you can build the library by running :command:`make`.
Once the library has been built you can invoke :command:`make test` to run
the tests.
@ -74,17 +74,17 @@ This will generate the HTML documenation in ``doc/html``.
Android NDK
===========
C++ Format provides `Android.mk file`__ that can be used to build the library
fmt 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>`_
For an example of using fmt with Android NDK, see the
`android-ndk-example <https://github.com/fmtlib/android-ndk-example>`_
repository.
__ https://github.com/cppformat/cppformat/blob/master/Android.mk
__ https://github.com/fmtlib/fmt/blob/master/Android.mk
Homebrew
========
C++ Format can be installed on OS X using `Homebrew <http://brew.sh/>`_::
fmt can be installed on OS X using `Homebrew <http://brew.sh/>`_::
brew install cppformat