misc: Add a top level README to describe the purpose of this repository

Holger Hans Peter Freyther 11 years ago
parent d6dcddd654
commit 03922c2750
  1. 19

@ -0,0 +1,19 @@
== This is the osmocomBB Docbook collection ==
The goal is to have various docbooks describing hardware and software
used/created by the osmocomBB Project
== Requirements ==
You will need to install the docbook, docbook-utils, dblatex, xmlto
and make package to create the docbook. Changing into a subdirectory
and typing 'make' should build the documentation. The result should
be in a subfolder like pdf/usermanual.pdf (or txt, html, xhtml). The
primary documentation target is the PDF format.
== List of Books ==
=== Filter Rework ===
This manual should help you to do the filter replacement and tell you
a bit of the history/development of this modification.