Changed readme to reStructuredText

timlyo · timlyo · commit f8718ac0f8fd · 2016-03-31T09:24:11.000+01:00
diff --git a/README.rst b/README.rst
@@ -1,5 +1,4 @@
-===============
- Python-uinput
+Python-uinput
 ===============
 
 Python-uinput is Python interface to Linux uinput kernel module which
@@ -14,41 +13,41 @@ Homepage: <http://tjjr.fi/sw/python-uinput/>
 Usage examples
 ==============
 
-Generate keyboard clicks:
+**Generate keyboard clicks:**
+
+    import uinput
+
+    with uinput.Device([uinput.KEY_E, uinput.KEY_H,
+                        uinput.KEY_L, uinput.KEY_O]) as device:
+        device.emit_click(uinput.KEY_H)
+        device.emit_click(uinput.KEY_E)
+        device.emit_click(uinput.KEY_L)
+        device.emit_click(uinput.KEY_L)
+        device.emit_click(uinput.KEY_O)
+
+**Move mouse cursor:**
 
-  import uinput
-  
-  with uinput.Device([uinput.KEY_E, uinput.KEY_H,
-                      uinput.KEY_L, uinput.KEY_O]) as device:
-      device.emit_click(uinput.KEY_H)
-      device.emit_click(uinput.KEY_E)
-      device.emit_click(uinput.KEY_L)
-      device.emit_click(uinput.KEY_L)
-      device.emit_click(uinput.KEY_O)
+    import uinput
 
-Move mouse cursor:
+    with uinput.Device([uinput.REL_X, uinput.REL_Y,
+                        uinput.BTN_LEFT, uinput.BTN_RIGHT]) as device:
+        for i in range(20):
+            device.emit(uinput.REL_X, 5)
+            device.emit(uinput.REL_Y, 5)
 
-  import uinput
-  
-  with uinput.Device([uinput.REL_X, uinput.REL_Y,
-                      uinput.BTN_LEFT, uinput.BTN_RIGHT]) as device:
-      for i in range(20):
-          device.emit(uinput.REL_X, 5)
-          device.emit(uinput.REL_Y, 5)
+**Generate keyboard combinations:**
 
-Generate keyboard combinations:
+    import uinput
 
-  import uinput
-  
-  with uinput.Device([uinput.KEY_LEFTALT, uinput.KEY_TAB]) as device:
-      device.emit_combo([uinput.KEY_LEFTALT, uinput.KEY_TAB])
+    with uinput.Device([uinput.KEY_LEFTALT, uinput.KEY_TAB]) as device:
+        device.emit_combo([uinput.KEY_LEFTALT, uinput.KEY_TAB])
 
 See examples/ for other kind of example devices (keyboard, joystick).
 
 Note that you must have the uinput kernel module loaded to use
 python-uinput. To load the module, run:
 
-  modprobe -i uinput
+    modprobe -i uinput
 
 If you would like to have uinput to be loaded on every sytem boot, add
 uinput to /etc/modules.
@@ -58,16 +57,16 @@ How to install
 
 Just run the following commands:
 
-  python setup.py build
-  python setup.py install
+    python setup.py build
+    python setup.py install
 
 How to report bugs
 ==================
 
 The bug database is hosted in GitHub. If you have found a bug or have an
 improvement idea you want to share, please report it at
 <https://github.com/tuomasjjrasanen/python-uinput/issues>. However, to avoid
-duplicate bug reports, before reporting, please check if similiar or identical
+duplicate bug reports, before reporting, please check if similar or identical
 bug has already been reported. If so, you can still subscribe to the existing
 bug to track its progress.
 
@@ -78,7 +77,7 @@ In addition to reporting bugs and improvement suggestions, you are encouraged to
 contribute bug-fixes or features. The source code is maintained in Git and the
 main repository is hosted at GitHub,
 <https://github.com/tuomasjjrasanen/python-uinput/>. The preferred way to
-contibute code is to clone the main Git repository and send a pull-request. Good
+contribute code is to clone the main Git repository and send a pull-request. Good
 old patches via email are also accepted.
 
 How to copy
