Quelt
=====
A lightweight offline Wikipedia reader.

Compilation Requirements
------------
* C99 compiler
* Unix environment.  Some win32 shims exist, but they are untested.
* Expat (only for quelt-split)
* Zlib

Building
--------
$ make

Usage
-----
    $ ./quelt-split [path to XML dump] [-v]
    $ ./quelt [part of title] --search [--plain]
    $ ./quelt [exact title] [--plain]

File format
-----------
The initial plan was for Quelt to use a separate file for every article, using
the path for the article name.  A cute idea, but reality set in fairly quickly:

* Filename restrictions, especially on NTFS
* Standard filesystem tools are not built to handle 3 million+ files easily

So instead, a custom binary format is used with two files: quelt.db, and
quelt.index.

TODO: file format documentation (still undergoing churn)

Quelt
=====
A lightweight offline Wikipedia reader.

Compilation Requirements
------------
* C99 compiler
* Unix environment.  Some win32 shims exist, but they are untested.
* Expat (only for quelt-split)
* Zlib

Building
--------
    $ make

Usage
-----
    $ ./quelt-split [path to XML dump] [-v]
    $ ./quelt [part of title] --search [--plain]
    $ ./quelt [exact title] [--plain]

File format
-----------
The initial plan was for Quelt to use a separate file for every article, using
the path for the article name.  A cute idea, but reality set in fairly quickly:

* Filename restrictions, especially on NTFS
* Standard filesystem tools are not built to handle 3 million+ files easily

So instead, a custom binary format is used with two files: quelt.db, and
quelt.index.

TODO: file format documentation (still undergoing churn)

Put building instructions in a code block. Oops.
Put building instructions in a code block.  Oops.
