From fa06e31b42339a8d642eb845e8e12bfff4911651 Mon Sep 17 00:00:00 2001 From: Robert H Date: Thu, 28 May 2026 20:54:09 -0500 Subject: [PATCH] Add license and readme --- LICENSE.md | 22 ++++++++++++++++++++++ README.md | 15 +++++++++++++++ 2 files changed, 37 insertions(+) create mode 100644 LICENSE.md create mode 100644 README.md diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..d1c6ace --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,22 @@ +MIT License + +Copyright (c) 2026 Robert Hrusecky + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. + diff --git a/README.md b/README.md new file mode 100644 index 0000000..3b87686 --- /dev/null +++ b/README.md @@ -0,0 +1,15 @@ +# Transcribble + +A scribble of a python script for audio transcription + +## Setup + +1. Install [python](https://www.python.org/downloads/) +2. Set up a virtual environment (optional) + - `python -m venv .venv` + - POSIX: `. .venv/bin/activate` + - Windows (PowerShell): `.venv\Scripts\Activate.ps1` + - If PowerShell refuses with “running scripts is disabled on this system,” run + `Set-ExecutionPolicy -Scope CurrentUser RemoteSigned` once, then try activation again. + - Windows (cmd.exe): `venv\Scripts\activate.bat` +3. Install dependences: `pip install -r requirements.txt`