From 5d893cb509e0a7d1e2b30092d57fcefb023cb8e5 Mon Sep 17 00:00:00 2001 From: Ultrabug Date: Wed, 16 Apr 2014 11:51:29 +0200 Subject: fix formatting to markdown --- README.md | 42 +++++++++++++++++------------------------- 1 file changed, 17 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index bf61505..dc94f54 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,3 @@ -========= py3status ========= **py3status** is an extensible i3status wrapper written in python. @@ -10,8 +9,7 @@ Using py3status, you can take control of your i3bar easily by: No extra configuration file needed, just install & enjoy ! -Documentation -============= +## Documentation See the wiki for up to date documentation: https://github.com/ultrabug/py3status/wiki @@ -21,48 +19,43 @@ Learn how to write your own modules: Get help or share your ideas on IRC: channel **#py3status** on **FreeNode** -Requirements -============ +## Requirements You **must** set the `output_format` to `i3bar` in the general section of your i3status.conf: -:: + general { colors = true interval = 5 output_format = "i3bar" } -Usage -===== +## Usage In your i3 config file, simply switch from `i3status` to `py3status` in your `status_command`: -:: + status_command py3status Usually you have your own i3status configuration, just point to it: -:: + status_command py3status -c ~/.i3/i3status.conf -Installation (all users) -======================== +## Installation +### Pypi py3status is available on pypi: -:: + $ pip install py3status -Installation (Gentoo users) -=========================== +### Gentoo Linux py3status is available on portage: -:: + $ sudo emerge -a py3status -Installation (Arch users) -========================= +### 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 --debug be verbose in syslog -i INCLUDE_PATHS include user-written modules from those directories @@ -72,9 +65,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. -:: + killall -USR1 py3status -- cgit v1.3