masq/i3pystatus
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Link devdocs in README

Browse Source
This commit is contained in:
enkore 2014-05-03 02:11:06 +02:00
parent 1bcc38802a
commit beff75b9c0
2 changed files with 8 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.rst
View File

@ -379,7 +379,7 @@ Settings:
:alert_format_title: The title of the notification, all formatters can be used (default: ``Low battery``)
:alert_format_body: The body text of the notification, all formatters can be used (default: ``Battery {battery_ident} has only {percentage:.2f}% ({remaining:%E%hh:%Mm}) remaining!``)
:path: Override the default-generated path (default: ``None``)
:status: A dictionary mapping ('DIS', 'CHR', 'FULL') to alternative names (default: ``{'FULL': 'FULL', 'CHR': 'CHR', 'DIS': 'DIS'}``)
:status: A dictionary mapping ('DIS', 'CHR', 'FULL') to alternative names (default: ``{'CHR': 'CHR', 'DIS': 'DIS', 'FULL': 'FULL'}``)
:color: The text color (default: ``#ffffff``)
:critical_color: The critical color (default: ``#ff0000``)
:interval: (default: ``5``)
@ -666,7 +666,7 @@ Settings:
:host: (default: ``localhost``)
:port: MPD port (default: ``6600``)
:format: formatp string (default: ``{title} {status}``)
:status: Dictionary mapping pause, play and stop to output (default: ``{'stop': '◾', 'play': '▶', 'pause': '▷'}``)
:status: Dictionary mapping pause, play and stop to output (default: ``{'stop': '◾', 'pause': '▷', 'play': '▶'}``)
:interval: (default: ``1``)
@ -937,5 +937,8 @@ the protocol is documented `here <http://i3wm.org/docs/i3bar-protocol.html>`_.
To update this readme run ``python -m i3pystatus.mkdocs`` in the
repository root and you're done :)
Developer documentation is available in the source code and `here
<http://i3pystatus.readthedocs.org/en/latest/>`_.
**Patches and pull requests are very welcome :-)**

3
README.tpl.rst
View File

@ -313,4 +313,7 @@ the protocol is documented `here <http://i3wm.org/docs/i3bar-protocol.html>`_.
To update this readme run ``python -m i3pystatus.mkdocs`` in the
repository root and you're done :)
Developer documentation is available in the source code and `here
<http://i3pystatus.readthedocs.org/en/latest/>`_.
**Patches and pull requests are very welcome :-)**