Revised README

tuomasjjrasanen · tuomasjjrasanen · commit 757ee3312868 · 2011-12-30T21:56:53.000+02:00
diff --git a/README b/README
@@ -1,14 +1,18 @@
-Python-uinput
-=============
+=====================
+ Python-uinput 0.6.2
+=====================
 
 Uinput is a Linux kernel module which allows attaching user-space
 device drivers into the Linux kernel. Python-uinput provides a
 pythonic API to the Linux uinput-system.
 
-Usage example
--------------
+Author: Tuomas Jorma Juhani Räsänen <tuomasjjrasanen@tjjr.fi>
+Homepage: <http://tjjr.fi/sw/python-uinput/>
 
-Create and use a new uinput device with key-capabilities:
+How to use
+==========
+
+Create an input device with key-capabilities and use it to type a greeting:
 
     import uinput
 
@@ -27,20 +31,48 @@ Create and use a new uinput device with key-capabilities:
     device.emit(uinput.KEY_O, 1)
     device.emit(uinput.KEY_O, 0)
 
-General information
--------------------
+How to install
+==============
+
+Python-uinput uses libudev and therefore requires libudev development
+files, more specifically libudev.h, to get compiled. On Debian and its
+derivatives, the header file is packaged in libudev-dev.
+
+After satisfying dependencies described above, the basic installation
+is easy. Just run the following command:
+
+  python setup.py install --prefix=/usr/local
+
+How to report bugs
+==================
+
+The bug database is hosted in Launchpad. If you have found a bug or
+have an improvement idea you want to share, please report it at
+<https://bugs.launchpad.net/python-uinput>. However, to avoid
+duplicate bug reports, before reporting, please check if similiar or
+identical bug has already been reported. If the description of the
+existing bug report If so, you can still subscribe to the existing bug
+to track its progress.
+
+If you are unsure whether the problem you have is due to a bug, you
+can ask questions at <https://answers.launchpad.net/python-uinput>.
+
+How to contribute
+=================
 
-- Version:    0.6.2
-- License:    GPLv3+ (see COPYING for details)
-- Author:     Tuomas Jorma Juhani Räsänen <tuomasjjrasanen@tjjr.fi>
-- Homepage:   <http://tjjr.fi/software/python-uinput/>
-- Code:       <https://code.launchpad.net/python-uinput/>
-- Bugs:       <https://bugs.launchpad.net/python-uinput/>
+In addition to reporting bugs and improvement suggestions, you are
+encouraged to contribute bug-fixes or features. Source code is
+maintained in Git VCS. The main repository is hosted in GitHub,
+<https://github.com/tuomasjjrasanen/python-uinput/> and mirrored in
+Launchpad as a Bazaar repository. The preferred way to contibute code
+is to clone the main Git repository and send a pull-request. Good old
+patches via email are also accepted.
 
-Requirements
-------------
+How to copy
+===========
 
-- libudev0
-- libudev-dev
-- uinput.ko
-- rw-permissions to uinput device node
+Python-uinput is free (libre) software and licensed under the terms of
+GNU Public License version 3 or later. In short, it means that you are
+free to copy, modify and redistribute this software as long as you
+place the derivative work under a compatible license. See COPYING for
+details.
