aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--README19
1 files changed, 19 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..6aefd47
--- /dev/null
+++ b/README
@@ -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.
+