From db60cf13de9a71b07c7b3c9558e5c9f6792bca4b Mon Sep 17 00:00:00 2001
From: "jazz (gitea)" <jazz@airmail.cc>
Date: Mon, 27 Oct 2025 13:08:52 -0500
Subject: [PATCH] initial help page

---
 README      | 13 -------------
 README.md   |  6 ++++++
 src/help.py | 44 ++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 50 insertions(+), 13 deletions(-)
 delete mode 100644 README
 create mode 100644 README.md
 create mode 100644 src/help.py

diff --git a/README b/README
deleted file mode 100644
index 5f98063..0000000
--- a/README
+++ /dev/null
@@ -1,13 +0,0 @@
-                                   
-     ▗▖     █                      
-     ▐▌     ▀   ▐▌   ▐▌            
-▗▟██▖▐▌▟▛  ██  ▐███ ▐███  ▟█▙  █▟█▌
-▐▙▄▖▘▐▙█    █   ▐▌   ▐▌  ▐▙▄▟▌ █▘  
- ▀▀█▖▐▛█▖   █   ▐▌   ▐▌  ▐▛▀▀▘ █   
-▐▄▄▟▌▐▌▝▙ ▗▄█▄▖ ▐▙▄  ▐▙▄ ▝█▄▄▌ █   
- ▀▀▀ ▝▘ ▀▘▝▀▀▀▘  ▀▀   ▀▀  ▝▀▀  ▀   
-                                   
-                                   
-Nothing here yet, but something here soon.
-Tune in tomorrow, same bat-time, same bat-channel.
-
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..bc64cd8
--- /dev/null
+++ b/README.md
@@ -0,0 +1,6 @@
+# skitter
+
+"skitter" *intransitive verb* "To pass or glide lightly or with quick touches at intervals; to skip; to skim."
+
+*from the GNU version of the Collaborative International Dictionary of English.*
+
diff --git a/src/help.py b/src/help.py
new file mode 100644
index 0000000..382a218
--- /dev/null
+++ b/src/help.py
@@ -0,0 +1,44 @@
+#!/usr/bin/env python3
+VERSION = "0.0.0"
+BANNER = r'''
+     ▗▖     █                      
+     ▐▌     ▀   ▐▌   ▐▌            
+▗▟██▖▐▌▟▛  ██  ▐███ ▐███  ▟█▙  █▟█▌
+▐▙▄▖▘▐▙█    █   ▐▌   ▐▌  ▐▙▄▟▌ █▘  
+ ▀▀█▖▐▛█▖   █   ▐▌   ▐▌  ▐▛▀▀▘ █   
+▐▄▄▟▌▐▌▝▙ ▗▄█▄▖ ▐▙▄  ▐▙▄ ▝█▄▄▌ █   
+ ▀▀▀ ▝▘ ▀▘▝▀▀▀▘  ▀▀   ▀▀  ▝▀▀  ▀   
+ '''
+
+USAGE = r'''
+ ./skitter.py [--band|-b FREQ] [--squelch|-s LEVEL] [--rate|-r SPEED] [--output|-o DIR]
+ 
+         --band
+         -b
+                 Desired frequencies (list) to scan.
+                 Skitter will sweep through these frequencies at a set rate.
+
+         --squelch
+         -s
+                 Level at which to start listening, in decibels (dB).
+                 Anything below this level will be ignored.
+
+         --rate
+         -s
+                 Rate at which to switch channels. Default: UNSET
+                 Change this is your device is not able to change channels
+                 quickly enough.
+
+         --output
+         -o
+                 Output directory. Default: ./
+                 Skitter will save its recordings in a single directory.
+                 You might want to create a new directory for recordings.
+'''
+
+def help():
+    print(BANNER)
+    print(f"skitter v{VERSION}")
+    print(USAGE)
+
+help()