workman161 / glovebox

In this file:

* About Glovebox
* Licensing
* Hardware Recomendations
* Build Requirements
* Bugs

About Glovebox
--------------

Glovebox is the project name for the suite of programs and libraries suitable
for use in a car computing environment. The suite is optimized for use with a
low-powered computer system and a touchscreen. It is meant to run with
Qt/Embedded Linux, but normal Qt works just fine. That means that anywhere Qt
runs, Glovebox can run.

Licensing
---------
The Glovebox project is generally covered under version 3 of the GNU Public
License. Individual components may have different licenses, so when in doubt,
check the individual files.

Hardware Recomendations
----------------------
As Glovebox's use is intended for that of an in-car assistant, a small, low
horsepower computer is all that is needed. 256MB of RAM, a small solid state
disk, 1GHz CPU, and a cheap graphics chip should work just fine.

Build Requirements
-----------------
The build system is CMake, so all you have to do is run ``cmake .''
from your source directory. If you are building for Qt/Embedded linux
be sure that you set your PATH variable to the proper location.

The GPS navigation uses Marble to draw the maps. If you are building against
Qt/Embedded, you should check out the latest SVN: 

  svn co svn://websvn.kde.org/home/kde/trunk/KDE/kdeedu/marble

Install it to the prefix you are installing Glovebox to.

Sound output uses Qt's Phonon implementation, so you need to
make sure your Qt has that compiled in.

Bugs
----
None yet. The project is too small to have any :)

But when they do crop up, a bug tracker will be up somewhere.