granicus.if.org Git - fortune-mod/blob - README.md

   1 # fortune-mod Maintenance Version and Ongoing Development
   2
   3 [![Build Status](https://travis-ci.org/shlomif/fortune-mod.svg?branch=master)](https://travis-ci.org/shlomif/fortune-mod)
   4
   5 This GitHub repository maintains the sources for fortune-mod, a
   6 version of
   7 [the UNIX fortune command](https://en.wikipedia.org/wiki/Fortune_%28Unix%29).
   8 `fortune` is a command-line utility which displays a random quotation from a
   9 collection of quotes. This collection is read from the local [file system](https://en.wikipedia.org/wiki/File_system)
  10 and does not require network access. A large collection of quotes is provided in
  11 the download and installed by default, but more quote collections can be added
  12 by the user.
  13
  14 The canonical repository for the time being is:
  15 https://github.com/shlomif/fortune-mod . In the future, we may create a GitHub
  16 organization for it and move the sources there.
  17
  18 For more information about it, you can contact
  19 [Shlomi Fish](https://www.shlomifish.org/) .
  20
  21 ## Release Tarballs
  22
  23 Release tarballs can be found at [this directory](https://www.shlomifish.org/open-source/projects/fortune-mod/arcs/)
  24 for now.
  25
  26 Reading from [this reported bug](https://github.com/shlomif/fortune-mod/issues/10):
  27
  28 One can find the official release tarballs of fortune-mod as prepared by CPack
  29 there. They have a proper containing directory. Please don't use GitHub's tags
  30 for that.
  31
  32 ## Sample usage
  33
  34 ```
  35 $ fortune
  36 Enthusiasm is one of the most important
  37 ingredients a volunteer project runs on.
  38                 -- Andreas Schuldei
  39 $
  40 ```
  41
  42 ## History
  43
  44 I believe fortune-mod was originally forked from the NetBSD version of
  45 fortune, and ported to run on Linux systems. For some time it was maintained
  46 at the currently offline redellipse-dot-net inside a
  47 [GNU Arch](http://en.wikipedia.org/wiki/GNU_arch) (= an old and now mostly
  48 unused version control system) repository, and version 1.99.1 was released as
  49 a tarball.
  50
  51 This maintenance version was initiated by Shlomi Fish, who decided to maintain
  52 it out of being a fan of the fortune command. It started by importing the
  53 unpacked source of the fortune-mod-1.99.1.tar tarball from the Mageia Linux
  54 .src.rpm into an empty git repository and continuing from there.
  55
  56 # What was already done.
  57
  58 1. fortune-mod-1.99.1 was imported into the repository from the Mageia tarball
  59 as the tag <code>fortune-mod-1.99.1</code>.
  60
  61 2. Converted the build system to [CMake](https://en.wikipedia.org/wiki/CMake) .
  62
  63 3. Converted the source files to UTF-8.
  64
  65 4. Added some tests.
  66
  67 5. Removed trailing whitespace.
  68
  69 6. Reformatted long (> 80 chars) lines.
  70
  71 7. Fixed some typos.
  72
  73 8. Added [Travis-CI](https://travis-ci.org/) testing.
  74
  75 9. Added valgrind tests and fixed some memory leaks.
  76
  77 10. Released fortune-mod-1.99.3, fortune-mod-1.99.4, v2.0.0 and up to
  78 version 2.16.0
  79
  80 11. Fixed some C compiler warnings encountered with the GCC compiler flags of
  81 [Shlomif_Common](https://bitbucket.org/shlomif/shlomif-cmake-modules/overview).
  82
  83 12. Added a build-time option to remove the “-o” (= “offensive”) flag, inspired
  84 by a set of patches on the Fedora package.
  85
  86 13. Applied some downstream patches.
  87
  88 14. Fixed as many “clang -Weverything” warnings as possible.
  89
  90 15. lib-recode became maintained again at https://github.com/rrthomas/recode
  91 (thanks to @rrthomas ) thus preventing a switch to something else.
  92
  93 16. Got the build and tests to pass on [AppVeyor/MS Windows](https://ci.appveyor.com/project/shlomif/fortune-mod)
  94 (with some appreciated help).
  95
  96 # What remains to be done.
  97
  98 1. See if there are any more downstream patches to apply.
  99
 100 2. Fix more typos (reports and pull-requests are welcome.)
 101
 102 3. Perhaps modernize the code a little.
 103
 104 4. Add more quotes / fortune cookies.
 105
 106 5. Prepare packages for the new releases for [downstream distributions/Operating Systems](https://pkgs.org/download/fortune-mod).
 107
 108 # Links
 109
 110 * [Shlomi Fish’s Fortune Cookie Files](https://www.shlomifish.org/humour/fortunes/) - on his site, containing links to many other collections of fortune cookies.
 111 * [XML-Grammar-Fortune](https://web-cpan.shlomifish.org/modules/XML-Grammar-Fortune/) - an XML grammar for collections of quotes, allowing one to generate XHTML or plaintext.
 112 * [Anvari.org’s web interface to fortune](http://www.anvari.org/fortune/) - with
 113 many collections.