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

Minor changes to readme

Browse Source
This commit is contained in:
enkore 2014-04-23 14:33:54 +02:00
parent 1c713b0b95
commit aef55aaad0
2 changed files with 32 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
README.rst
View File

@ -1,11 +1,10 @@
.. Always edit README.tpl.md and create README.md by running .. Always edit README.tpl.rst
python -m i3pystatus.mkdocs You can also let the maintainer do the
latter :)
i3pystatus i3pystatus
========== ==========
.. image:: https://travis-ci.org/enkore/i3pystatus.svg?branch=master :target: https://travis-ci.org/enkore/i3pystatus .. image:: https://travis-ci.org/enkore/i3pystatus.svg?branch=master
:target: https://travis-ci.org/enkore/i3pystatus
i3pystatus is a (hopefully growing) collection of python scripts for i3pystatus is a (hopefully growing) collection of python scripts for
status output compatible to i3status / i3bar of the i3 window manager. status output compatible to i3status / i3bar of the i3 window manager.
@ -13,8 +12,11 @@ status output compatible to i3status / i3bar of the i3 window manager.
Installation Installation
------------ ------------
Note: i3pystatus requires Python 3.2 or newer and is not compatible with .. admonition:: Note
Python 2.x.
i3pystatus requires Python 3.2 or newer and is not compatible with
Python 2.x. Some modules require additional dependencies
documented below (see `Modules`_).
From PyPI package `i3pystatus <https://pypi.python.org/pypi/i3pystatus>`_ From PyPI package `i3pystatus <https://pypi.python.org/pypi/i3pystatus>`_
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
@ -31,7 +33,8 @@ Packages for your OS
Release Notes Release Notes
------------- -------------
Contributors: Contributors
++++++++++++
* aaron-lebo * aaron-lebo
* afics * afics
@ -106,8 +109,9 @@ Configuration
The config file is just a normal Python script. The config file is just a normal Python script.
A simple configuration file could look like this (note the additional dependencies A simple configuration file could look like this (note the additional
from network, wireless and pulseaudio in this example): dependencies from `network`_, `wireless`_ and `pulseaudio`_ in this
example):
:: ::
@ -266,7 +270,7 @@ a mere extension of the standard formatting method.
The time format that should be used is specified using the format specifier, i.e. The time format that should be used is specified using the format specifier, i.e.
with some_time being 3951 seconds a format string like ``{some_time:%h:%m:%s}`` with some_time being 3951 seconds a format string like ``{some_time:%h:%m:%s}``
would produce ``1:5:51`` would produce ``1:5:51``.
* ``%h``, ``%m`` and ``%s`` are the hours, minutes and seconds without * ``%h``, ``%m`` and ``%s`` are the hours, minutes and seconds without
leading zeros (i.e. 0 to 59 for minutes and seconds) leading zeros (i.e. 0 to 59 for minutes and seconds)
@ -281,7 +285,7 @@ would produce ``1:5:51``
* When the module in question also uses formatp, 0 seconds counts as * When the module in question also uses formatp, 0 seconds counts as
"not known". "not known".
* The formatted time is stripped, i.e. spaces on both ends of the * The formatted time is stripped, i.e. spaces on both ends of the
result are removed result are removed.
Modules Modules
------- -------
@ -373,7 +377,7 @@ Settings:
:alert_format_title: The title of the notification, all formatters can be used (default: ``Low battery``) :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!``) :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``) :path: Override the default-generated path (default: ``None``)
:status: A dictionary mapping ('DIS', 'CHR', 'FULL') to alternative names (default: ``{'CHR': 'CHR', 'FULL': 'FULL', 'DIS': 'DIS'}``) :status: A dictionary mapping ('DIS', 'CHR', 'FULL') to alternative names (default: ``{'DIS': 'DIS', 'FULL': 'FULL', 'CHR': 'CHR'}``)
:color: The text color (default: ``#ffffff``) :color: The text color (default: ``#ffffff``)
:critical_color: The critical color (default: ``#ff0000``) :critical_color: The critical color (default: ``#ff0000``)
:interval: (default: ``5``) :interval: (default: ``5``)
@ -660,7 +664,7 @@ Settings:
:host: (default: ``localhost``) :host: (default: ``localhost``)
:port: MPD port (default: ``6600``) :port: MPD port (default: ``6600``)
:format: formatp string (default: ``{title} {status}``) :format: formatp string (default: ``{title} {status}``)
:status: Dictionary mapping pause, play and stop to output (default: ``{'play': '▶', 'pause': '▷', 'stop': '◾'}``) :status: Dictionary mapping pause, play and stop to output (default: ``{'stop': '◾', 'pause': '▷', 'play': '▶'}``)
:interval: (default: ``1``) :interval: (default: ``1``)

26
README.tpl.rst
View File

@ -1,11 +1,10 @@
.. Always edit README.tpl.md and create README.md by running .. Always edit README.tpl.rst
python -m i3pystatus.mkdocs You can also let the maintainer do the
latter :)
i3pystatus i3pystatus
========== ==========
.. image:: https://travis-ci.org/enkore/i3pystatus.svg?branch=master :target: https://travis-ci.org/enkore/i3pystatus .. image:: https://travis-ci.org/enkore/i3pystatus.svg?branch=master
:target: https://travis-ci.org/enkore/i3pystatus
i3pystatus is a (hopefully growing) collection of python scripts for i3pystatus is a (hopefully growing) collection of python scripts for
status output compatible to i3status / i3bar of the i3 window manager. status output compatible to i3status / i3bar of the i3 window manager.
@ -13,8 +12,11 @@ status output compatible to i3status / i3bar of the i3 window manager.
Installation Installation
------------ ------------
Note: i3pystatus requires Python 3.2 or newer and is not compatible with .. admonition:: Note
Python 2.x.
i3pystatus requires Python 3.2 or newer and is not compatible with
Python 2.x. Some modules require additional dependencies
documented below (see `Modules`_).
From PyPI package `i3pystatus <https://pypi.python.org/pypi/i3pystatus>`_ From PyPI package `i3pystatus <https://pypi.python.org/pypi/i3pystatus>`_
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
@ -31,7 +33,8 @@ Packages for your OS
Release Notes Release Notes
------------- -------------
Contributors: Contributors
++++++++++++
* aaron-lebo * aaron-lebo
* afics * afics
@ -106,8 +109,9 @@ Configuration
The config file is just a normal Python script. The config file is just a normal Python script.
A simple configuration file could look like this (note the additional dependencies A simple configuration file could look like this (note the additional
from network, wireless and pulseaudio in this example): dependencies from `network`_, `wireless`_ and `pulseaudio`_ in this
example):
:: ::
@ -266,7 +270,7 @@ a mere extension of the standard formatting method.
The time format that should be used is specified using the format specifier, i.e. The time format that should be used is specified using the format specifier, i.e.
with some_time being 3951 seconds a format string like ``{some_time:%h:%m:%s}`` with some_time being 3951 seconds a format string like ``{some_time:%h:%m:%s}``
would produce ``1:5:51`` would produce ``1:5:51``.
* ``%h``, ``%m`` and ``%s`` are the hours, minutes and seconds without * ``%h``, ``%m`` and ``%s`` are the hours, minutes and seconds without
leading zeros (i.e. 0 to 59 for minutes and seconds) leading zeros (i.e. 0 to 59 for minutes and seconds)
@ -281,7 +285,7 @@ would produce ``1:5:51``
* When the module in question also uses formatp, 0 seconds counts as * When the module in question also uses formatp, 0 seconds counts as
"not known". "not known".
* The formatted time is stripped, i.e. spaces on both ends of the * The formatted time is stripped, i.e. spaces on both ends of the
result are removed result are removed.
Modules Modules
------- -------