Skip to content

Commit 45ae5eb

Browse files
Fix rst markup in README.rst
1 parent 9250c0f commit 45ae5eb

1 file changed

Lines changed: 21 additions & 11 deletions

File tree

README.rst

Lines changed: 21 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
Python-uinput
1+
===============
2+
Python-uinput
23
===============
34

45
Python-uinput is Python interface to Linux uinput kernel module which
@@ -7,13 +8,16 @@ Python-uinput makes it dead simple to create virtual joysticks,
78
keyboards and mice for generating arbitrary input events
89
programmatically.
910

10-
Author: Tuomas Räsänen <tuomasjjrasanen@tjjr.fi>
11-
Homepage: <http://tjjr.fi/sw/python-uinput/>
11+
:Homepage: http://tjjr.fi/sw/python-uinput/
12+
:License: GPLv3+
1213

1314
Usage examples
1415
==============
1516

16-
**Generate keyboard clicks:**
17+
Generate keyboard clicks
18+
------------------------
19+
20+
::
1721

1822
import uinput
1923

@@ -25,7 +29,10 @@ Usage examples
2529
device.emit_click(uinput.KEY_L)
2630
device.emit_click(uinput.KEY_O)
2731

28-
**Move mouse cursor:**
32+
Move mouse cursor
33+
-----------------
34+
35+
::
2936

3037
import uinput
3138

@@ -35,27 +42,30 @@ Usage examples
3542
device.emit(uinput.REL_X, 5)
3643
device.emit(uinput.REL_Y, 5)
3744

38-
**Generate keyboard combinations:**
45+
Generate keyboard combinations
46+
------------------------------
47+
48+
::
3949

4050
import uinput
4151

4252
with uinput.Device([uinput.KEY_LEFTALT, uinput.KEY_TAB]) as device:
4353
device.emit_combo([uinput.KEY_LEFTALT, uinput.KEY_TAB])
4454

45-
See examples/ for other kind of example devices (keyboard, joystick).
55+
See ``examples/`` for other kind of example devices (keyboard, joystick).
4656

4757
Note that you must have the uinput kernel module loaded to use
48-
python-uinput. To load the module, run:
58+
python-uinput. To load the module, run::
4959

5060
modprobe -i uinput
5161

5262
If you would like to have uinput to be loaded on every sytem boot, add
53-
uinput to /etc/modules.
63+
uinput to ``/etc/modules``.
5464

5565
How to install
5666
==============
5767

58-
Just run the following commands:
68+
Just run the following commands::
5969

6070
python setup.py build
6171
python setup.py install
@@ -86,4 +96,4 @@ How to copy
8696
Python-uinput is free (libre) software and licensed under the terms of GNU
8797
Public License version 3 or later. In short, it means that you are free to copy,
8898
modify and redistribute this software as long as you place the derivative work
89-
under a compatible license. See COPYING for details.
99+
under a compatible license. See ``COPYING`` for details.

0 commit comments

Comments
 (0)