From 596d01c8bda10156a1a0f06b6f921a6065847cad Mon Sep 17 00:00:00 2001 From: Victor Zverovich Date: Fri, 7 Dec 2012 13:33:08 -0800 Subject: [PATCH] Write README. --- README.rst | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/README.rst b/README.rst index f1b04b8f..74f8b294 100644 --- a/README.rst +++ b/README.rst @@ -73,6 +73,8 @@ As you can see boost::format is much slower than the alternative methods; this is confirmed by `other tests `__. Tinyformat is quite good coming close to iostreams. Unfortunately tinyformat cannot be faster than the iostreams because it uses them internally. +Performance of format is close to that of std::ostream but there is a room for +improvement since format is not based on iostreams. Running the tests ~~~~~~~~~~~~~~~~~ @@ -81,7 +83,8 @@ To run the tests you first need to get the format repository with submodules:: $ git clone --recursive git://github.com/vitaut/format.git -Then go to the format directory and generate Makefiles with CMake:: +Then go to the format directory and generate Makefiles with +`CMake `__:: $ cd format $ cmake . @@ -100,5 +103,7 @@ Acknowledgments The benchmark section of this readme file and the performance tests are taken from the excellent `tinyformat `__ library written by Chris Foster. boost::format is acknowledged transitively since -it had some influence on tinyformat. -TODO: SafeFormat, Clang DiagnosticHandler +it had some influence on tinyformat. Some ideas used in the implementation +are borrowed from `Loki `__ SafeFormat and +`Diagnostic API `__ +in `Clang `__.