summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorUltrabug <ultrabug@gentoo.org>2013-04-19 13:02:30 +0200
committerUltrabug <ultrabug@gentoo.org>2013-04-19 13:02:30 +0200
commitf805889f55e0a65a565b6dfac5f9d5727381938c (patch)
tree4d1207ff92fc493723b340ef73bb212db8549a03 /README.md
parent1008b7fc9fd1a88b5ae45d65fcbfee616fce1595 (diff)
add MANIFEST.in and switch README.rst for pypi
Diffstat (limited to 'README.md')
-rwxr-xr-xREADME.md57
1 files changed, 0 insertions, 57 deletions
diff --git a/README.md b/README.md
deleted file mode 100755
index 0df6315..0000000
--- a/README.md
+++ /dev/null
@@ -1,57 +0,0 @@
-py3status
-=========
-
-py3status is an extensible i3status wrapper written in python
-
-## Documentation
-See the [wiki](https://github.com/ultrabug/py3status/wiki) for up to date documentation.
-
-## Requirements
-You must set the `output_format` to `i3bar` in the general section of your i3status.conf:
-
- general {
- output_format = "i3bar"
- }
-
-## Installation (all users)
-py3status is available on pypi:
-
- $ pip install py3status
-
-## Installation (Gentoo users)
-Add the `ultrabug` overlay on layman:
-
- $ sudo layman -a ultrabug
-
-Install py3status:
-
- $ sudo emerge -a py3status
-
-## 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
-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
-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
-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