initial help page

README

@@ -1,13 +0,0 @@
-                                   
-     ▗▖     █                      
-     ▐▌     ▀   ▐▌   ▐▌            
-▗▟██▖▐▌▟▛  ██  ▐███ ▐███  ▟█▙  █▟█▌
-▐▙▄▖▘▐▙█    █   ▐▌   ▐▌  ▐▙▄▟▌ █▘  
- ▀▀█▖▐▛█▖   █   ▐▌   ▐▌  ▐▛▀▀▘ █   
-▐▄▄▟▌▐▌▝▙ ▗▄█▄▖ ▐▙▄  ▐▙▄ ▝█▄▄▌ █   
- ▀▀▀ ▝▘ ▀▘▝▀▀▀▘  ▀▀   ▀▀  ▝▀▀  ▀   
-                                   
-                                   
-Nothing here yet, but something here soon.
-Tune in tomorrow, same bat-time, same bat-channel.
-

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.*
+

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()