Initial commit

1 files changed, 30 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..7133d0b
--- /dev/null
+++ b/README
@@ -0,0 +1,30 @@
+Libplanfahr is a GObject based library to query public transport inforation. It
+(in principle) supports different providers although at the moment only one is
+implemented. It features GObject introspection so you can use it from languages
+like JavaScript and Python. 
+
+The API is by no means stable yet.
+
+It depends on glib, libsoup, libxml2:
+
+    apt-get install libsoup2.4-dev libglib2.0-dev libxml2-dev gobject-introspection
+
+To build from source use:
+
+    ./autogen.sh
+    ./configure
+     make
+
+To install use
+
+    make install
+
+To run from the compiled source code use
+
+   ./run <program>
+
+for example
+
+   ./run python examples/trip-query.py Gelsenkirchen Essen
+
+If you want to contribute to libplanfahr see the HACKING document.