Author: Josh Moore <firstname.lastname@example.org>
Date: Mon, 15 Jun 2020 17:38:00 -0400
Merge pull request #124 from mdoege/readme
6 files changed, 16 insertions(+), 7 deletions(-)
diff --git a/snakewm/apps/clocks/aclock/README.md b/snakewm/apps/clocks/aclock/README.md
@@ -1,5 +1,6 @@
-SnakeClock displays the current time in a small window.
+SnakeAClock is an analog clock that displays the current time in a small window. It is based on my AmigaClock code, but with a modified dial design and caching of the empty dial image for better performance. The pygame_gui-related stuff is taken from dance.py.
diff --git a/snakewm/apps/clocks/berlin/README.md b/snakewm/apps/clocks/berlin/README.md
@@ -1,8 +1,8 @@
-The is a PyGame version of the [Berlin clock](https://en.wikipedia.org/wiki/Berlin_Clock).
+A PyGame version of the [Berlin clock](https://en.wikipedia.org/wiki/Berlin_Clock) (aka set theory clock) which was installed in a central location in Berlin on June 17, 1975. In 1996 it was moved to a new slightly more hidden location where it still stands today. You could (and still can) also buy official tabletop reproductions of it in Berlin souvenir shops.
-How to read:
+This is a 24 hour clock. How to read:
* hour = 5 * lights in first row + lights in second row
* minute = 5 * lights in third row + lights in fourth row
diff --git a/snakewm/apps/fun/dazzler/README.md b/snakewm/apps/fun/dazzler/README.md
@@ -1,5 +1,8 @@
-Snazzler is a kaleidoscope similar to the one for the Cromemco Dazzler (1976).
+Snazzler is a kaleidoscope similar to the one for the Cromemco Dazzler (1976) (see https://www.youtube.com/watch?v=W-481UnBl_w and https://en.wikipedia.org/wiki/Cromemco_Dazzler).
+The program uses the EGA/Sega Master System color palette (64 colors, 4 levels per channel).
The window is resizable, press Space to pause, "." to advance one frame.
diff --git a/snakewm/apps/games/zap/README.md b/snakewm/apps/games/zap/README.md
@@ -1,7 +1,8 @@
-Zap is a Python version of Space Zap (1980). Play with cursor keys and Space to fire.
-The player is awarded a bonus base every 75,000 points.
+Zap is a Python version of Space Zap (Midway 1980, see https://www.arcade-museum.com/game_detail.php?game_id=9692) running at a resolution of 160x120. Guard the space station from enemy fighters and occasional evil killer satellites. Play with the cursor keys and press Space to fire.
+The player is awarded a bonus base every 75,000 points. It is easier than the arcade original because difficulty does not ramp up, on the other hand the enemy can also fire from off screen in this version. Then again, you can also shoot off-screen enemies.
The window is resizable, press "p" to pause, "." to advance one frame.
diff --git a/snakewm/apps/system/cpumon/README.md b/snakewm/apps/system/cpumon/README.md
@@ -1,6 +1,10 @@
Displays a bar graph of CPU usage.
+The graph goes from 0% at the bottom to 100% at the top, showing combined CPU use of all cores/threads. It's 100 px high, so each pixel vertically equals one percent. This is for all threads combined, so e.g. if on a system with 16 threads there are 8 threads running at 100% and the other 8 are idle, the graph would show 50% total CPU use.
+Horizontally, the graph is 200px wide, so being set to 4 FPS, it shows the last 50 s.
Data is either read via ``psutil`` if available or directly from ``/proc/stat`` (only works on Linux).
diff --git a/snakewm/apps/system/fps/README.md b/snakewm/apps/system/fps/README.md
@@ -1,5 +1,5 @@
-FPS displays the current frame rate.
+FPS displays the current, average, minimum, and maximum frame rate. By default, the last 300 samples are used for average/min/max.