diff --git a/.gitignore b/.gitignore index 81ced4d..90e576f 100644 --- a/.gitignore +++ b/.gitignore @@ -30,4 +30,8 @@ Cargo.lock # be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore # and can be added to the global gitignore or merged into this file. For a more nuclear # option (not recommended) you can uncomment the following to ignore the entire idea folder. -#.idea/ \ No newline at end of file +#.idea/ + +# mdbook +/docs/output +/docs/src/scripts \ No newline at end of file diff --git a/scripts/1p-bridge b/scripts/1p-bridge index 5ba223d..037034d 100755 --- a/scripts/1p-bridge +++ b/scripts/1p-bridge @@ -1,15 +1,20 @@ #! /usr/bin/env python3 -"""1password bridge +""" +# `1p-bridge`: 1password bridge This script can expose the `op` cli utility as a web service. Callers can then pass a 1password service token through an HTTP request, and are able to read secrets from 1password. +This allows the use of 1password as a basic secret store for self-hosted applications. + +``` HTTP routes: /whoami GET: Returns the current user's information /read/ GET: Reads the item at the specified URI +``` """ import argparse diff --git a/scripts/ableton-linux b/scripts/ableton-linux index 2feb4ea..199f366 100755 --- a/scripts/ableton-linux +++ b/scripts/ableton-linux @@ -1,4 +1,10 @@ #! /usr/bin/env python3 +""" +# `ableton-linux`: Ableton Wrapper for Linux + +This script handles the necessary setup and pre-configuration to run Ableton Live on Linux with low-latency audio. +""" + import argparse import os import sys diff --git a/scripts/baofeng2gqrx b/scripts/baofeng2gqrx index d21bff9..e8785a2 100644 --- a/scripts/baofeng2gqrx +++ b/scripts/baofeng2gqrx @@ -1,3 +1,5 @@ +#! /usr/bin/env python3 + import argparse import sys import csv diff --git a/scripts/cursedecompiler b/scripts/cursedecompiler index f135ae3..af55c06 100644 --- a/scripts/cursedecompiler +++ b/scripts/cursedecompiler @@ -1,3 +1,5 @@ +#! /usr/bin/env python3 + import argparse import os from typing import * diff --git a/scripts/lyrics2ptr b/scripts/lyrics2ptr index d2cac70..7d4e52f 100755 --- a/scripts/lyrics2ptr +++ b/scripts/lyrics2ptr @@ -1,3 +1,5 @@ +#! /usr/bin/env python3 + import argparse import sys import re