add README and udev file

1 files changed, 39 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f3ea2a2
--- /dev/null
+++ b/README.md
@@ -0,0 +1,39 @@
+# Screenshots #
+
+![](http://depot.javispedro.com/livescribe/scribiu1.png)
+
+# About #
+
+**Scribiu** is a program that shows the notebooks and voice notes (_paper replay_)
+from [Livescribe Echo](http://www.livescribe.com) smartpens.
+It also allows you to export individual pages as PNG files or voice memos as AAC files.
+
+# Requirements #
+
+Scribiu requires Qt 4.8, including the core, gui, svg and phonon modules.
+It also requires libudev, openobex, libusb (<1.0) and QuaZip.
+Most of these should be packaged by your distribution.
+
+Note that this program is not compatible with anything other than the Livescribe Echo.
+It does not work with the Livescribe 3.
+It may work with the Livescribe Sky if you get it to work with Echo Desktop, but I have never tried.
+
+# Install # 
+
+`qmake`, `make`, and `make install` should be enough.
+
+A udev rule will be installed in `/etc/udev/60-livescribe.rules` that will take care of the proper permissions when a Smartpen is detected.
+You may need to reboot or reload the udev daemon in order for these changes to work.
+
+![Scribiu icon](https://git.javispedro.com/cgit/scribiu.git/plain/icons/48x48/scribiu.png) 
+Look for the Scribiu icon inside the Office menu.
+
+It should automatically start synchronizing after connecting a Smartpen.
+
+# Design #
+
+By default Scribiu stores its information inside `$XDG_DATA_HOME/data/scribiu`.
+Inside there you will find a directory for every synchronized pen, and inside the pen directory, you will find a subdirectory for each one of your LiveScribe notebooks.
+These directories contain the raw notebook, stroke, and voice data as received from the pen -- no processing is done.
+
+Therefore, even if Scribiu fails to display a certain notebook, you may be able to use other Livescribe programs in order to view the synchronized data.