From c916ab3319661d3181260c3ae64501ca989345a7 Mon Sep 17 00:00:00 2001 From: Victor Zverovich Date: Wed, 27 Apr 2016 08:35:59 -0700 Subject: [PATCH] Update docs --- doc/_templates/layout.html | 12 ++++++------ doc/api.rst | 4 ++-- doc/index.rst | 14 +++++++------- doc/usage.rst | 28 ++++++++++++++-------------- 4 files changed, 29 insertions(+), 29 deletions(-) diff --git a/doc/_templates/layout.html b/doc/_templates/layout.html index c1b72b37..934538d6 100644 --- a/doc/_templates/layout.html +++ b/doc/_templates/layout.html @@ -42,7 +42,7 @@ - C++ Format + {fmt} {# Collect the nav links, forms, and other content for toggling #} @@ -77,18 +77,18 @@ {% if pagename == "index" %}
-

C++ Format

+

{fmt}

Small, safe and fast formatting library for C++

+ href="https://github.com/fmtlib/fmt/releases/download/2.0.0/cppformat-2.0.0.zip"> Download
diff --git a/doc/api.rst b/doc/api.rst index 618b5130..0dda96a5 100644 --- a/doc/api.rst +++ b/doc/api.rst @@ -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`:: diff --git a/doc/index.rst b/doc/index.rst index 35c56f04..73bc4c22 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -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 `_, @@ -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 -`_ allows using the library both +`_ allows using the library both in open-source and commercial projects. .. raw:: html - GitHub Repository + GitHub Repository
-
diff --git a/doc/usage.rst b/doc/usage.rst index bee62ed2..2d22f001 100644 --- a/doc/usage.rst +++ b/doc/usage.rst @@ -2,9 +2,9 @@ Usage ***** -To use the C++ Format library, add :file:`format.h` and :file:`format.cc` from -a `release archive `_ -or the `Git repository `_ to your project. +To use the fmt library, add :file:`format.h` and :file:`format.cc` from +a `release archive `_ +or the `Git repository `_ to your project. Alternatively, you can :ref:`build the library with CMake `. 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 # Generate native build scripts. + cmake # Generate native build scripts. -where :file:`{}` is a path to the ``cppformat`` repository. +where :file:`{}` 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 `_. -For an example of using C++ Format with Android NDK, see the -`android-ndk-example `_ +For an example of using fmt with Android NDK, see the +`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 `_:: +fmt can be installed on OS X using `Homebrew `_:: brew install cppformat