diff options
| -rw-r--r-- | MANIFEST.in | 2 | ||||
| -rw-r--r--[-rwxr-xr-x] | README.rst (renamed from README.md) | 42 |
2 files changed, 27 insertions, 17 deletions
diff --git a/MANIFEST.in b/MANIFEST.in new file mode 100644 index 0000000..90f2f44 --- /dev/null +++ b/MANIFEST.in @@ -0,0 +1,2 @@ +include *.rst +include examples/* diff --git a/README.md b/README.rst index 0df6315..bef3a97 100755..100644 --- a/README.md +++ b/README.rst @@ -3,55 +3,63 @@ py3status py3status is an extensible i3status wrapper written in python -## Documentation +Documentation +========= See the [wiki](https://github.com/ultrabug/py3status/wiki) for up to date documentation. -## Requirements +Requirements +========= You must set the `output_format` to `i3bar` in the general section of your i3status.conf: - +:: general { output_format = "i3bar" } -## Installation (all users) +Installation (all users) +========= py3status is available on pypi: - +:: $ pip install py3status -## Installation (Gentoo users) +Installation (Gentoo users) +========= Add the `ultrabug` overlay on layman: - +:: $ sudo layman -a ultrabug Install py3status: - +:: $ sudo emerge -a py3status -## Installation (Arch users) +Installation (Arch users) +========= Thanks to @waaaaargh, py3status is present in the Arch User Repository using this URL: - +:: https://aur.archlinux.org/packages/py3status-git/ -## Usage +Usage +========= In your i3 config file, simply change the `status_command` with: - +:: status_command py3status Usually you have your own i3status configuration, just point to it: - +:: status_command py3status -c ~/.i3/i3status.conf -## Options +Options +========= You can see the help of py3status by issuing `py3status -h`: - +:: -c I3STATUS_CONF path to i3status config file -d disable integrated transformations -i INCLUDE_PATH user-based class include directory (default .i3/py3status) -n INTERVAL update interval in seconds (default 1 sec) -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 |