diff --git a/README.md b/README.md index aee4968..38774c7 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,18 @@ -# skitter +# 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.* +`skitter` is an easy way to snoop on many low-activity radio channels without expensive equipment, +designed for use with the low-cost software-defined radio platform RTLSDR. + +See `skitter --help` to learn how to use it. + ![help page screenshot](sc.png) +# Installation + +You will need the `pyproject-build` command. +It is available through the [build](https://github.com/pypa/build) package for Python. + diff --git a/sc.png b/sc.png index 8297ff6..8620f9d 100644 Binary files a/sc.png and b/sc.png differ diff --git a/skitter/usage.py b/skitter/usage.py index bda787e..48abe96 100644 --- a/skitter/usage.py +++ b/skitter/usage.py @@ -7,7 +7,6 @@ def print_help(): """print help""" NAME = "skitter.py" VERSION = "0.0.0" - BANNER = '''\x1b[34m ▗▖ █ ▄ ▐▌ ▀ ▐▌ ▐▌ █ @@ -18,10 +17,12 @@ def print_help(): ▀▀▀ ▝▘ ▀▘▝▀▀▀▘ ▀▀ ▀▀ ▝▀▀ ▀ ▀ \x1b[0m''' USAGE = f''' + Rapidly sweep through many radio channels and record interesting activity. + SYNOPSIS {NAME} [--band=|-b FREQ] [--out-directory=|-o DIR] [--squelch=|-s LEVEL] [--rate=|-r SPEED] {NAME} [--help|-h] - + --band -b Desired frequencies (list) to scan. @@ -50,7 +51,7 @@ def print_help(): -h Print this message and exit. - Examples + EXAMPLES {NAME} -r 300 Sweep through default range and change channels every 300 milliseconds.