diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..a2b2126 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,21 @@ +# The MIT License (MIT) + +Copyright (c) 2025 Stevan Freeborn + +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..4f10d97 --- /dev/null +++ b/README.md @@ -0,0 +1,43 @@ +# dotnet-local-transcription + +A simple .NET-based tool for local audio transcription. This project provides a straightforward way to transcribe audio files on your machine, leveraging .NET for fast and reliable processing. + +## Features + +- Local audio transcription (no cloud required) +- Easy to use command-line interface +- Fast and efficient processing +- Open source and MIT licensed + +## Getting Started + +### Prerequisites + +- [.NET 10 SDK](https://dotnet.microsoft.com/download) installed on your machine + +### Usage + +1. Clone the repository: + + ```sh + git clone https://github.com/yourusername/dotnet-local-transcription.git + cd dotnet-local-transcription + ``` + +2. Build the project: + +```pwsh +dotnet build +``` + +3. Run the transcription tool: + +```pwsh +dotnet run -- +``` + +Replace `` with the path to your audio file. + +## License + +This project is licensed under the MIT License. See `LICENSE.md` for details.