From f842fd70923e7b07ac38b1cab79334e863d400ad Mon Sep 17 00:00:00 2001 From: enkore Date: Sun, 20 Oct 2013 18:51:16 +0200 Subject: [PATCH] Module guide --- README.md | 33 ++++++++++++++++++++++++++++++++- README.tpl.md | 31 +++++++++++++++++++++++++++++++ 2 files changed, 63 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 2071a3f..6017f9e 100644 --- a/README.md +++ b/README.md @@ -233,6 +233,37 @@ removed from the string. ## Modules +System: +[Clock](#clock) +[Free space](#disk) +[System load](#load) +[Memory usage](#mem) + +Audio: +[ALSA](#alsa) +[PulseAudio](#pulseaudio) + +Hardware: +[Battery](#battery) +[Screen brightness](#backlight) +[CPU temperature (Intel)](#temp) + +Network: +[Wired](#network) +[Wireless](#wireless) + +Other: +[Unread mail](#mail) +[Tracking parcels](#parcel) +[pyLoad](#pyload) +[Weather](#weather) +[Music Player Daemon (MPD)](#mpd) + +Advanced: +[Rip info from files](#file) +[Regular expressions](#regex) +[Run watcher](#runwatch) + ### alsa @@ -307,7 +338,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: `{'DIS': 'DIS', 'CHR': 'CHR', 'FULL': 'FULL'}`) +* `status` — A dictionary mapping ('DIS', 'CHR', 'FULL') to alternative names (default: `{'CHR': 'CHR', 'FULL': 'FULL', 'DIS': 'DIS'}`) diff --git a/README.tpl.md b/README.tpl.md index 7f0ea63..a64efc7 100644 --- a/README.tpl.md +++ b/README.tpl.md @@ -233,6 +233,37 @@ removed from the string. ## Modules +System: +[Clock](#clock) +[Free space](#disk) +[System load](#load) +[Memory usage](#mem) + +Audio: +[ALSA](#alsa) +[PulseAudio](#pulseaudio) + +Hardware: +[Battery](#battery) +[Screen brightness](#backlight) +[CPU temperature (Intel)](#temp) + +Network: +[Wired](#network) +[Wireless](#wireless) + +Other: +[Unread mail](#mail) +[Tracking parcels](#parcel) +[pyLoad](#pyload) +[Weather](#weather) +[Music Player Daemon (MPD)](#mpd) + +Advanced: +[Rip info from files](#file) +[Regular expressions](#regex) +[Run watcher](#runwatch) + !!module_doc!! ## Contribute