From 30aaf22db36dd69887182d4efd400146fdf24e43 Mon Sep 17 00:00:00 2001
From: Javier <dev.git@javispedro.com>
Date: Sun, 14 Jun 2015 18:12:19 +0200
Subject: add README and udev file

---
 60-livescribe.rules |  1 +
 README.md           | 39 +++++++++++++++++++++++++++++++++++++++
 scribiu.pro         |  7 ++++++-
 3 files changed, 46 insertions(+), 1 deletion(-)
 create mode 100644 60-livescribe.rules
 create mode 100644 README.md

diff --git a/60-livescribe.rules b/60-livescribe.rules
new file mode 100644
index 0000000..340ac5a
--- /dev/null
+++ b/60-livescribe.rules
@@ -0,0 +1 @@
+SUBSYSTEM=="usb", ENV{ID_VENDOR}=="Livescribe", TAG+="udev-acl", TAG+="livescribe-pen"
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.
diff --git a/scribiu.pro b/scribiu.pro
index afb596c..1431351 100644
--- a/scribiu.pro
+++ b/scribiu.pro
@@ -48,6 +48,9 @@ isEmpty(PREFIX) {
 
 target.path = $$PREFIX/bin
 
+udev.path = /etc/udev/rules.d
+udev.files = 60-livescribe.rules
+
 icon_scalable.path = $$PREFIX/share/icons/hicolor/scalable/apps
 icon_scalable.files = icons/scalable/scribiu.svg
 
@@ -57,4 +60,6 @@ icon_48.files = icons/48x48/scribiu.png
 desktop.path = $$PREFIX/share/applications
 desktop.files = scribiu.desktop
 
-INSTALLS += target icon_scalable icon_48 desktop
+INSTALLS += target udev icon_scalable icon_48 desktop
+
+OTHER_FILES = icons/inkscape/scribiu.svg README.md
-- 
cgit v1.2.3