Change name from hdata to hddb
[hdata.git] / README
blobadc983bd050577dee1ee35b15085b1140d210525
1 hddb: the simple Haskell Document Database 
3 a simple sqlite-powered document tracker for the command-line
5 === Installation ===
7 you will need to install the following BUILD dependencies:
9     * GHC:          http://www.haskell.org/ghc/        
10     * HDBC-Sqlite3: http://hackage.haskell.org/package/HDBC-sqlite3
12 you will need to install the following RUN-TIME dependencies:
14     * Sqlite3:      http://www.sqlite.org
16 to build, simply run:
18     $ make
20 to install, run:
22     # make install
24 alternatively, control the install location with the 'PREFIX' and 'DESTDIR'
25 environment variables (or simply edit the Makefile).
27 === Using ===
29 After building and installing,
31 $ hddb help
33 === Development ===
35 Grab the latest source and report bugs at:
37     https://www.github.com/gagnonlg/hddb
39 Get in touch with the author at:
41     louis.guillaume.gagnon@gmail.com
43 === ===== ===
45 Copyright (C) 2013 Louis-Guillaume Gagnon
47 This program may be freely redistributed under the terms
48 of the GNU General Public License, version 3 or later.
49 For more information, see 'COPYING'