File	Date	Author	Commit
doc	2010-02-06	Ionutz Borcoman	[3d4c46] Start work on IFileSystem.
src	2010-06-19	Ionutz Borcoman	[453682] Moved classes from libs/items into ibocator::it...
valgrind	2010-03-22	Ionutz Borcoman	[8ffaea] Moved valgrind suppressions into a common dir.
AUTHORS	2010-03-21	Ionutz Borcoman	[9637c6] Changed license to AGPLv3.
COPYING	2010-03-21	Ionutz Borcoman	[9637c6] Changed license to AGPLv3.
README	2010-04-24	Ionutz Borcoman	[5cfc66] Updated the README and todo list.
ibocator.pro	2010-04-01	Ionutz Borcoman	[dd08b1] Renamed elocator into ibocator. Set title of th...
make_dist	2010-05-25	Ionutz Borcoman	[1f1ec5] Better exclude pattern.

Read Me

ibocator - a cataloging tool for GNU/Linux
==========================================

http://sourceforge.net/projects/ibocator/


Why ibocator?
-------------

The original name for the project was book-locator as the initial goal of the
project was to catalog ebooks. During development I've started to realise that
for the moment it was better to concentrate on the CdCat clonning and let the
book handling stuff for later. When I've created the project on SourceForge, in
my frenzy of moving stuff there, I've decided for a new and better name.
SourceForge shown that elocator is free, so I've simply taken it. With great
dissapointment I've discovered days later that there was already a commercial
application with that name. To avoid any future troubles and as the project is
still in infancy, I've decided to rename it. After some brainstorming, we came
up with some name that hopefully is not already taken (Google doesn't return
anything at this time), even though a bit stupid: 

  ibocatori, aka iborco's locator

  initial name: book-locator
  release 0.1:  book-locator >> elocator
  release 0.3:  elocator >> ibocator


Current todo list
-----------------

A local TODO list is kept using tudu. To view it, run in the top directory:

  $ tudu -f tudu.xml

You can find tudu at http://www.cauterized.net/~meskio/tudu/.


Libraries needed to compile
---------------------------

qt4           http://qt.nokia.com/downloads          LGPL v2.1
gio           http://www.gtk.org/                    LGPL v2.1
google test   http://code.google.com/p/googletest/   New BSD License
google mock   http://code.google.com/p/googlemock/   New BSD License
boost         http://www.boost.org/                  Boost Software License

Various compile methods
-----------------------

* to treat warnings as errors
  $ qmake QMAKE_CXXFLAGS+=-Wfatal-errors

* to build for debug
  $ qmake CONFIG+=debug

* to do code coverage with gcov:

  $ qmake "CONFIG+=debug gcov"
  
  after that, go to the test dir of interest and run:

  $ make gcov