summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorUltrabug <ultrabug@gentoo.org>2014-05-03 19:52:23 +0200
committerUltrabug <ultrabug@gentoo.org>2014-05-03 19:52:23 +0200
commitc60cb1bc7af0afccaabbcd94b16055d35a1d6031 (patch)
treeadb94143226bff8ce626ee46722d484b9f87a3d3
parentc9f710b70b7f1e6fc37ef9b86993d78d21442078 (diff)
fix formatting back to RST
-rw-r--r--README.rst45
1 files changed, 27 insertions, 18 deletions
diff --git a/README.rst b/README.rst
index 2e2a021..f0b3867 100644
--- a/README.rst
+++ b/README.rst
@@ -1,28 +1,32 @@
+*********
py3status
-=========
+*********
**py3status** is an extensible i3status wrapper written in python.
Using py3status, you can take control of your i3bar easily by:
- - writing your own modules and have their output displayed on your bar
- - handling click events on your i3bar and play with them in no time
- - seeing your clock tick every second whatever your i3status interval
+
+- writing your own modules and have their output displayed on your bar
+- handling click events on your i3bar and play with them in no time
+- seeing your clock tick every second whatever your i3status interval
No extra configuration file needed, just install & enjoy !
-## Documentation
+Documentation
+=============
See the wiki for up to date documentation:
-* https://github.com/ultrabug/py3status/wiki
+- https://github.com/ultrabug/py3status/wiki
Learn how to write your own modules:
-* https://github.com/ultrabug/py3status/wiki/Write-your-own-modules
+- https://github.com/ultrabug/py3status/wiki/Write-your-own-modules
Get help or share your ideas on IRC:
-* channel **#py3status** on **FreeNode**
+- channel **#py3status** on **FreeNode**
-## Requirements
+Requirements
+============
You **must** set the `output_format` to `i3bar` in the general section of your i3status.conf:
general {
@@ -31,7 +35,8 @@ You **must** set the `output_format` to `i3bar` in the general section of your i
output_format = "i3bar"
}
-## Usage
+Usage
+=====
In your i3 config file, simply switch from `i3status` to `py3status` in your `status_command`:
status_command py3status
@@ -40,23 +45,26 @@ Usually you have your own i3status configuration, just point to it:
status_command py3status -c ~/.i3/i3status.conf
-## Installation
-### Pypi
-py3status is available on pypi:
+Installation
+============
+Pypi
+----
$ pip install py3status
-### Gentoo Linux
-py3status is available on portage:
+Gentoo Linux
+------------
$ sudo emerge -a py3status
-### Arch Linux
+Arch Linux
+----------
Thanks to @waaaaargh, py3status is present in the Arch User Repository using this URL:
https://aur.archlinux.org/packages/py3status-git/
-## Options
+Options
+=======
You can see the help of py3status by issuing `py3status -h`:
-c I3STATUS_CONF path to i3status config file
@@ -68,7 +76,8 @@ You can see the help of py3status by issuing `py3status -h`:
-t CACHE_TIMEOUT default injection cache timeout in seconds
(default 60 sec)
-## Control
+Control
+=======
Just like i3status, you can force an update by sending a SIGUSR1 signal to py3status.
Note that this will also send a SIGUSR1 signal to i3status.