doc/ABOUT.mdwn.in

   1 # @LIBRARY_NAME@: @PROJECT_BRIEF@
   2
   3 ## about
   4
   5 @LIBRARY_NAME@ provides a simple exception-based assertion
   6 mechanism that can be used to realize a rudimentary
   7 design-by-contract policy.
   8
   9 It leverages [libsex][] to not only throw exceptions when
  10 boolean expressions evaluate to false, but also to
  11 declutter control flow by using macros that wrap new
  12 exceptions around those thrown by substatements, creating a
  13 concise backtrace that eases reconstruction of errors.
  14
  15
  16 ## news
  17
  18 * @PROJECT_VERSION_DATE@ @LIBRARY_NAME@-@PROJECT_VERSION@
  19 * 2010-03-13 development started
  20
  21
  22 ## changelog
  23
  24 ### @PROJECT_VERSION_DATE@ @LIBRARY_NAME@-@PROJECT_VERSION@
  25
  26 First public release. Requires libsex-3.0.0.
  27
  28
  29 ## dependencies
  30
  31 * [libsex][]
  32 * CMake
  33 * CppUnit (unit testing, optional)
  34 * Doxygen (API documentation, optional)
  35
  36
  37 ## bugs
  38
  39 None.
  40
  41
  42 ## authors
  43
  44 * Andreas Waidler <arandes@programmers.at>
  45
  46
  47 ## repo
  48
  49 * git://repo.or.cz/@LIBRARY_NAME@.git
  50 * <http://www.repo.or.cz/w/@LIBRARY_NAME@.git>
  51
  52
  53 ## homepage
  54
  55 * <http://programmers.at/work/on/@LIBRARY_NAME@>
  56
  57
  58 ## documentation
  59
  60 * <http://programmers.at/work/on/@LIBRARY_NAME@/doc>
  61
  62
  63 ## download
  64
  65 * <http://programmers.at/work/on/@LIBRARY_NAME@/@LIBRARY_NAME@-@PROJECT_VERSION@.tar.gz>
  66
  67
  68 ## license
  69
  70 Copyright (C) 2011 Andreas Waidler <arandes@programmers.at>
  71
  72 Permission to use, copy, modify, and/or distribute this
  73 software for any purpose with or without fee is hereby
  74 granted, provided that the above copyright notice and this
  75 permission notice appear in all copies.
  76
  77 THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS
  78 ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL
  79 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO
  80 EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
  81 INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  82 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
  83 WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
  84 TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE
  85 USE OR PERFORMANCE OF THIS SOFTWARE.
  86
  87 [libsex]: http://programmers.at/work/on/libsex