chore: add README and LICENSE

2025-08-08 12:19:30 -05:00
parent 7f8c38e3ed
commit a7099a6369
2 changed files with 64 additions and 0 deletions
@@ -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 -- <path-to-audio-file>
+```
+
+Replace `<path-to-audio-file>` with the path to your audio file.
+
+## License
+
+This project is licensed under the MIT License. See `LICENSE.md` for details.