README

   1 hddb: the simple Haskell Document Database
   2
   3 a simple sqlite-powered document tracker for the command-line
   4
   5 === Installation ===
   6
   7 you will need to install the following BUILD dependencies:
   8
   9     * GHC:          http://www.haskell.org/ghc/
  10     * HDBC-Sqlite3: http://hackage.haskell.org/package/HDBC-sqlite3
  11
  12 you will need to install the following RUN-TIME dependencies:
  13
  14     * Sqlite3:      http://www.sqlite.org
  15
  16 to build, simply run:
  17
  18     $ make
  19
  20 to install, run:
  21
  22     # make install
  23
  24 alternatively, control the install location with the 'PREFIX' and 'DESTDIR'
  25 environment variables (or simply edit the Makefile).
  26
  27 Also, configure Config.hs as you wish *before* the build
  28
  29 === Using ===
  30
  31 After building and installing,
  32
  33     $ hddb help
  34
  35 also,
  36
  37     $ man hddb
  38
  39 === Development ===
  40
  41 Grab the latest source and report bugs at:
  42
  43     https://www.github.com/gagnonlg/hddb
  44
  45 Get in touch with the author at:
  46
  47     louis.guillaume.gagnon@gmail.com
  48
  49 === ===== ===
  50
  51 Copyright (C) 2013 Louis-Guillaume Gagnon
  52
  53 This program may be freely redistributed under the terms
  54 of the GNU General Public License, version 3 or later.
  55 For more information, see 'COPYING'