Added meaningful descriptions to all non-documented modules

2026-09-10 07:26:25 -04:00 · 2018-03-15 22:34:26 -04:00 · 2018-03-15 22:34:26 -04:00 · d61571e77a
parent aef7e78e47
commit d61571e77a
26 changed files with 50 additions and 51 deletions
--- a/README.org
+++ b/README.org
@ -65,45 +65,45 @@ Advertise your module here, open a PR and include a org-mode link!
 # Don't edit anything below this line, the script will blow it away
 # --
 ** Utilities
- [[./util/ttf-fonts/README.org][ttf-fonts]] :: Describe ttf-fonts here
- [[./util/kbd-layouts/README.org][kbd-layouts]] :: Describe kbd-layouts here
- [[./util/screenshot/README.org][screenshot]] :: Describe screenshot here
+- [[./util/ttf-fonts/README.org][ttf-fonts]] :: A pure lisp implementation of TTF font rendering.
+- [[./util/kbd-layouts/README.org][kbd-layouts]] :: Keyboard layout switcher for StumpWM
+- [[./util/screenshot/README.org][screenshot]] :: Takes screenshots and stores them as png files
 - [[./util/alert-me/README.org][alert-me]] :: Alert me that an event is coming
 - [[./util/ft2-fonts/README.org][ft2-fonts]] :: An implementation of font rendering that allows users to select OTF/TTF fonts using FreeType rendering.
 - [[./util/winner-mode/README.org][winner-mode]] :: Emacs' winner-mode for StumpWM
- [[./util/windowtags/README.org][windowtags]] :: Describe windowtags here
+- [[./util/windowtags/README.org][windowtags]] :: Add metadata to windows to manipulate them en mass.
 - [[./util/notify/README.org][notify]] :: DBus-based notification server part
 - [[./util/qubes/README.org][qubes]] :: Integration to Qubes OS (https://www.qubes-os.org)
- [[./util/stumptray/README.org][stumptray]] :: Describe stumptray here
+- [[./util/stumptray/README.org][stumptray]] :: System Tray for stumpwm.
 - [[./util/numpad-layouts/README.org][numpad-layouts]] :: A module for handling different keyboards numpad layouts
 - [[./util/clipboard-history/README.org][clipboard-history]] :: Simple clipboard history module for StumpWM
- [[./util/globalwindows/README.org][globalwindows]] :: Describe globalwindows here
+- [[./util/globalwindows/README.org][globalwindows]] :: Manipulate all windows in the current X session
 - [[./util/urgentwindows/README.org][urgentwindows]] :: Allows focusing application windows that need user attention
 - [[./util/swm-gaps/README.org][swm-gaps]] :: Pretty (useless) gaps for StumpWM
 - [[./util/searchengines/README.org][searchengines]] :: Allows searching text using prompt or clipboard contents with various search engines
 - [[./util/command-history/README.org][command-history]] :: Save and load the stumpwm::*input-history* to a file
 - [[./util/logitech-g15-keysyms/README.org][logitech-g15-keysyms]] :: Describe logitech-g15-keysyms here
 - [[./util/pass/README.org][pass]] :: Integrate 'pass' with StumpWM
- [[./util/surfraw/README.org][surfraw]] :: Describe surfraw here
- [[./util/passwd/README.org][passwd]] :: Describe passwd here
- [[./util/swm-emacs/README.org][swm-emacs]] :: Describe emacs here
+- [[./util/surfraw/README.org][surfraw]] :: Integrates surfraw with stumpwm.
+- [[./util/passwd/README.org][passwd]] :: A simple password utility based on ironclad.
+- [[./util/swm-emacs/README.org][swm-emacs]] :: A set of utilities for launching the beast.
 - [[./util/pinentry/README.org][pinentry]] :: Integrate GnuPG Agent with StumpWM
- [[./util/app-menu/README.org][app-menu]] :: Describe app-menu here
- [[./util/perwindowlayout/README.org][perwindowlayout]] :: Describe perwindowlayout here
- [[./util/undocumented/README.org][undocumented]] :: Describe undocumented here
- [[./util/productivity/README.org][productivity]] :: Describe productivity here
+- [[./util/app-menu/README.org][app-menu]] :: A simple application menu for launching shell commands
+- [[./util/perwindowlayout/README.org][perwindowlayout]] :: Change the keyboard layout per window.
+- [[./util/undocumented/README.org][undocumented]] :: Look for stuff that should probably be in the manual that isn't
+- [[./util/productivity/README.org][productivity]] :: Lock StumpWM down so you have to get work done.
 ** Media
- [[./media/amixer/README.org][amixer]] :: Describe amixer here
- [[./media/aumix/README.org][aumix]] :: Describe aumix here
+- [[./media/amixer/README.org][amixer]] :: Manipulate the volume using amixer
+- [[./media/aumix/README.org][aumix]] :: Manipulate your volume with aumix
 ** Modeline
 - [[./modeline/hostname/README.org][hostname]] :: Put hostname in the StumpWM modeline
- [[./modeline/cpu/README.org][cpu]] :: Describe cpu here
- [[./modeline/battery-portable/README.org][battery-portable]] :: Describe battery-portable here
- [[./modeline/disk/README.org][disk]] :: Describe disk here
- [[./modeline/maildir/README.org][maildir]] :: Describe maildir here
- [[./modeline/mem/README.org][mem]] :: Describe mem here
- [[./modeline/wifi/README.org][wifi]] :: Describe wifi here
- [[./modeline/net/README.org][net]] :: Describe net here
+- [[./modeline/cpu/README.org][cpu]] :: Add cpu info to the modeline.
+- [[./modeline/battery-portable/README.org][battery-portable]] :: Add battery information to the modeline in a portable way.
+- [[./modeline/disk/README.org][disk]] :: Display filesystem information in the modeline
+- [[./modeline/maildir/README.org][maildir]] :: Display maildir information in the modeline (%M conflicts with mem).
+- [[./modeline/mem/README.org][mem]] :: Display memory in the modeline, %M conflicts with maildir.
+- [[./modeline/wifi/README.org][wifi]] :: Display information about your wifi.
+- [[./modeline/net/README.org][net]] :: Displays information about the current network connection.
 ** Minor Modes
- [[./minor-mode/mpd/README.org][mpd]] :: Describe mpd here
- [[./minor-mode/notifications/README.org][notifications]] :: Describe notifications here
+- [[./minor-mode/mpd/README.org][mpd]] :: Displays information about the music player daemon (MPD).
+- [[./minor-mode/notifications/README.org][notifications]] :: A notification library that sends notifications to the modeline via stumpish or from stumpwm itself.
--- a/media/amixer/amixer.asd
+++ b/media/amixer/amixer.asd
@ -2,7 +2,7 @@

 (asdf:defsystem #:amixer
  :serial t
-  :description "Describe amixer here"
+  :description "Manipulate the volume using amixer"
  :author "Amy Templeton, Jonathan Moore Liles, Ivy Foster"
  :license "GPL v3"
  :components ((:file "package")
--- a/media/aumix/aumix.asd
+++ b/media/aumix/aumix.asd
@ -2,7 +2,7 @@

 (asdf:defsystem #:aumix
  :serial t
-  :description "Describe aumix here"
+  :description "Manipulate your volume with aumix"
  :author "Fredrik Tolf"
  :license "GPLv3"
  :depends-on ("stumpwm")
--- a/minor-mode/mpd/mpd.asd
+++ b/minor-mode/mpd/mpd.asd
@ -2,7 +2,7 @@

 (asdf:defsystem #:mpd
  :serial t
-  :description "Describe mpd here"
+  :description "Displays information about the music player daemon (MPD)."
  :author "Morgan Veyret, Ivy Foster"
  :license "GPLv2"
  :depends-on ("stumpwm")
--- a/minor-mode/notifications/notifications.asd
+++ b/minor-mode/notifications/notifications.asd
@ -2,7 +2,7 @@

 (asdf:defsystem #:notifications
  :serial t
-  :description "Describe notifications here"
+  :description "A notification library that sends notifications to the modeline via stumpish or from stumpwm itself."
  :author "Tassilo Horn <tassilo@member.fsf.org>"
  :license "GPLv3"
  :depends-on (#:stumpwm)
--- a/modeline/battery-portable/battery-portable.asd
+++ b/modeline/battery-portable/battery-portable.asd
@ -2,7 +2,7 @@

 (asdf:defsystem #:battery-portable
  :serial t
-  :description "Describe battery-portable here"
+  :description "Add battery information to the modeline in a portable way."
  :author "Julian Stecklina"
  :license "GPLv3"
  :depends-on (#:stumpwm)
--- a/modeline/cpu/cpu.asd
+++ b/modeline/cpu/cpu.asd
@ -2,7 +2,7 @@

 (asdf:defsystem #:cpu
  :serial t
-  :description "Describe cpu here"
+  :description "Add cpu info to the modeline."
  :author "Anonymous Coward, Jonathan Moore Liles"
  :license "GPLv3"
  :depends-on (#:stumpwm)
--- a/modeline/disk/disk.asd
+++ b/modeline/disk/disk.asd
@ -2,7 +2,7 @@

 (asdf:defsystem #:disk
  :serial t
-  :description "Describe disk here"
+  :description "Display filesystem information in the modeline"
  :author "Morgan Veyret"
  :license "GPLv3"
  :depends-on (#:stumpwm)
--- a/modeline/maildir/maildir.asd
+++ b/modeline/maildir/maildir.asd
@ -2,7 +2,7 @@

 (asdf:defsystem #:maildir
  :serial t
-  :description "Describe maildir here"
+  :description "Display maildir information in the modeline (%M conflicts with mem). "
  :author "Morgan Veyret"
  :license "GPLv3"
  :depends-on (#:stumpwm)
--- a/modeline/mem/mem.asd
+++ b/modeline/mem/mem.asd
@ -2,7 +2,7 @@

 (asdf:defsystem #:mem
  :serial t
-  :description "Describe mem here"
+  :description "Display memory in the modeline, %M conflicts with maildir."
  :author "Vitaly Mayatskikh"
  :license "GPLv3"
  :depends-on (#:stumpwm)
--- a/modeline/net/net.asd
+++ b/modeline/net/net.asd
@ -2,7 +2,7 @@

 (asdf:defsystem #:net
  :serial t
-  :description "Describe net here"
+  :description "Displays information about the current network connection."
  :author "Vitaly Mayatskikh"
  :license "GPLv3"
  :depends-on (#:stumpwm)
--- a/modeline/wifi/wifi.asd
+++ b/modeline/wifi/wifi.asd
@ -2,7 +2,7 @@

 (asdf:defsystem #:wifi
  :serial t
-  :description "Describe wifi here"
+  :description "Display information about your wifi."
  :author "John Li"
  :license "GPLv3"
  :depends-on (#:stumpwm
--- a/util/app-menu/app-menu.asd
+++ b/util/app-menu/app-menu.asd
@ -2,7 +2,7 @@

 (asdf:defsystem #:app-menu
  :serial t
-  :description "Describe app-menu here"
+  :description "A simple application menu for launching shell commands"
  :author "Anonymous"
  :license "GPLv3"
  :depends-on (#:stumpwm)
--- a/util/globalwindows/README.org
+++ b/util/globalwindows/README.org
@ -1,9 +1,8 @@
 ** Problem
 Out of the box StumpWM provides tools to navigate windows only within
 group bounds - "windowlist" function seems to be the main, and maybe
-only useful here.
-But sometimes the user wants to manage or even simply overview *all*
-application windows present in X session.
+only useful here. But sometimes the user wants to manage or even
+simply overview *all* application windows present in X session.

 So, this contrib extension was written with purpose of providing the
 way to manage global windows list in rather straightforward manner.
--- a/util/globalwindows/globalwindows.asd
+++ b/util/globalwindows/globalwindows.asd
@ -2,7 +2,7 @@

 (asdf:defsystem #:globalwindows
  :serial t
-  :description "Describe globalwindows here"
+  :description "Manipulate all windows in the current X session"
  :author "Alex Ermolov"
  :license "GPLv3"
  :depends-on (#:stumpwm)
--- a/util/kbd-layouts/kbd-layouts.asd
+++ b/util/kbd-layouts/kbd-layouts.asd
@ -4,7 +4,7 @@

 (asdf:defsystem #:kbd-layouts
  :serial t
-  :description "Describe kbd-layouts here"
+  :description "Keyboard layout switcher for StumpWM"
  :author "Wojciech Gac"
  :license "GPLv3"
  :depends-on (#:stumpwm)
--- a/util/passwd/passwd.asd
+++ b/util/passwd/passwd.asd
@ -2,7 +2,7 @@

 (asdf:defsystem #:passwd
  :serial t
-  :description "Describe passwd here"
+  :description "A simple password utility based on ironclad."
  :author "Anonymous"
  :license "GPLv3"
  :depends-on (#:stumpwm #:ironclad)
--- a/util/perwindowlayout/perwindowlayout.asd
+++ b/util/perwindowlayout/perwindowlayout.asd
@ -2,7 +2,7 @@

 (asdf:defsystem #:perwindowlayout
  :serial t
-  :description "Describe perwindowlayout here"
+  :description "Change the keyboard layout per window."
  :author "Alex Ermolov"
  :license "GPLv3"
  :depends-on (#:stumpwm #:xkeyboard)
--- a/util/productivity/productivity.asd
+++ b/util/productivity/productivity.asd
@ -2,7 +2,7 @@

 (asdf:defsystem #:productivity
  :serial t
-  :description "Describe productivity here"
+  :description "Lock StumpWM down so you have to get work done."
  :author "Ivy Foster"
  :license "GPLv3"
  :depends-on (#:stumpwm)
--- a/util/screenshot/screenshot.asd
+++ b/util/screenshot/screenshot.asd
@ -2,7 +2,7 @@

 (asdf:defsystem #:screenshot
  :serial t
-  :description "Describe screenshot here"
+  :description "Takes screenshots and stores them as png files"
  :author "Michael Filonenko"
  :license "GPLv3"
  :depends-on (#:zpng)
--- a/util/stumptray/stumptray.asd
+++ b/util/stumptray/stumptray.asd
@ -4,7 +4,7 @@

 (asdf:defsystem #:stumptray
  :serial t
-  :description "Describe stumptray here"
+  :description "System Tray for stumpwm."
  :author "Michael Filonenko"
  :license "GPLv3"
  :depends-on (#:stumpwm
--- a/util/surfraw/surfraw.asd
+++ b/util/surfraw/surfraw.asd
@ -2,7 +2,7 @@

 (asdf:defsystem #:surfraw
  :serial t
-  :description "Describe surfraw here"
+  :description "Integrates surfraw with stumpwm."
  :author "Ivy Foster"
  :license "GPLv3"
  :depends-on (#:stumpwm)
--- a/util/swm-emacs/swm-emacs.asd
+++ b/util/swm-emacs/swm-emacs.asd
@ -2,7 +2,7 @@

 (asdf:defsystem #:swm-emacs
  :serial t
-  :description "Describe emacs here"
+  :description "A set of utilities for launching the beast."
  :author "David Bjergaard, Alexander aka 'CosmonauT' Vynnyk"
  :license "GPLv3"
  :depends-on (#:stumpwm)
--- a/util/ttf-fonts/ttf-fonts.asd
+++ b/util/ttf-fonts/ttf-fonts.asd
@ -2,7 +2,7 @@

 (asdf:defsystem #:ttf-fonts
  :serial t
-  :description "Describe ttf-fonts here"
+  :description "A pure lisp implementation of TTF font rendering."
  :author "Michael Filonenko"
  :license "GPLv3"
  :depends-on (#:stumpwm #:clx-truetype)
--- a/util/undocumented/undocumented.asd
+++ b/util/undocumented/undocumented.asd
@ -2,7 +2,7 @@

 (asdf:defsystem #:undocumented
  :serial t
-  :description "Describe undocumented here"
+  :description " Look for stuff that should probably be in the manual that isn't"
  :author "Ben Spencer"
  :license "GPLv3"
  :depends-on (#:stumpwm)
--- a/util/windowtags/windowtags.asd
+++ b/util/windowtags/windowtags.asd
@ -2,7 +2,7 @@

 (asdf:defsystem #:windowtags
  :serial t
-  :description "Describe windowtags here"
+  :description "Add metadata to windows to manipulate them en mass."
  :author "Michael Raskin"
  :license "GPLv3"
  :depends-on (#:stumpwm)