diff --git a/.gitignore b/.gitignore index a553afc..74ab29c 100644 --- a/.gitignore +++ b/.gitignore @@ -11,7 +11,6 @@ __pycache__/ # No audio files or summaries *.wav -*.md *.tns # Distribution / packaging diff --git a/README.md b/README.md new file mode 100644 index 0000000..94bc7b6 --- /dev/null +++ b/README.md @@ -0,0 +1,23 @@ +# AudioSumma + +Record your local audio and summarize it with whisper.cpp and llama.cpp! Open source, local on-prem transcription and summarization! + +## AudioSumma Installation + +``` +pip install -r requirements.txt +``` + +## Configuration + +Copy sample.env to .env and point your endpoint URLs for a working llama.cpp and whisper.cpp running in server/api mode. + +## Running + +Run either meetings.bat or meetings.sh to start app. + + +## Usage + +Hit record to record your global audio, hit stop to save the wav file. Hit transcribe to transcribe all wav files collected into a single summary markdown document (with date stamp). Hit the Clean button to remove old wav files and transcripts. +