doc/ABOUT.mdwn.in

   1 # @LIBRARY_NAME@: @PROJECT_BRIEF@
   2
   3 ## about
   4
   5 @LIBRARY_NAME@ is an exception library for C++ that avoids
   6 std::bad_alloc being thrown when you just don't want to
   7 have it, allows for safe chaining of exceptions, message
   8 backtraces, easy creation and localization of exception
   9 class hierarchies and their message templates, while being
  10 embarassingly simple.
  11
  12 Concrete usage examples contained in the tests directory.
  13
  14
  15 ## news
  16
  17 * @PROJECT_VERSION_DATE@ @LIBRARY_NAME@-@PROJECT_VERSION@
  18 * 2011-08-13 @LIBRARY_NAME@-3.0.0
  19 * 2010-09-26 @LIBRARY_NAME@-2.0.0 (never released)
  20 * 2010-03-12 @LIBRARY_NAME@-1.0.0 (never released)
  21 * 2010-02-19 development started
  22
  23
  24 ## changelog
  25
  26 ### @PROJECT_VERSION_DATE@ @LIBRARY_NAME@-@PROJECT_VERSION@
  27
  28 * fixed include directory (all platforms)
  29 * fixed installation locations (windows)
  30 * DECLARE/DEFINE now take scope as seperate parameter
  31
  32 ### 2011-08-13 @LIBRARY_NAME@-3.0.0
  33
  34 First public release.
  35
  36
  37 ## dependencies
  38
  39 * CMake
  40 * CppUnit (unit testing, optional)
  41 * Doxygen (API documentation, optional)
  42
  43
  44 ## bugs
  45
  46 None known.
  47
  48
  49 ## authors
  50
  51 * Andreas Waidler <arandes@programmers.at>
  52
  53
  54 ## repo
  55
  56 * git://repo.or.cz/@LIBRARY_NAME@.git
  57 * <http://www.repo.or.cz/w/@LIBRARY_NAME@.git>
  58
  59
  60 ## homepage
  61
  62 * <http://programmers.at/work/on/@LIBRARY_NAME@>
  63
  64
  65 ## documentation
  66
  67 * <http://programmers.at/work/on/@LIBRARY_NAME@/doc>
  68
  69
  70 ## download
  71
  72 * <http://programmers.at/work/on/@LIBRARY_NAME@/@LIBRARY_NAME@-@PROJECT_VERSION@.tar.gz>
  73 * <http://programmers.at/work/on/@LIBRARY_NAME@/@LIBRARY_NAME@-3.0.0.tar.gz>
  74
  75
  76 ## license
  77
  78 Copyright (C) 2011 Andreas Waidler <arandes@programmers.at>
  79
  80 Permission to use, copy, modify, and/or distribute this
  81 software for any purpose with or without fee is hereby
  82 granted, provided that the above copyright notice and this
  83 permission notice appear in all copies.
  84
  85 THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS
  86 ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL
  87 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO
  88 EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
  89 INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  90 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
  91 WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
  92 TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE
  93 USE OR PERFORMANCE OF THIS SOFTWARE.