admin/scribe
1
0
Fork 0
Code Issues Pull Requests Actions 3 Packages Projects Releases Wiki Activity

Update README to reflect current behavior
Mirror and run GitLab CI / build (push) Has been cancelled
Details

Browse Source 
- Remove PDF-related references
- Clarify DOCX format: no cover pages, transcript line-numbered
- Align output files and env vars with current implementation
This commit is contained in:
admin
2026-06-15 03:58:56 +00:00
parent b0a1bc059b
commit ea5a0752df
1 changed files with 8 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+8 -7
View File
@@ -3,7 +3,7 @@
ScrAIbe is a transcription and summarization service that: ScrAIbe is a transcription and summarization service that:
- Sends audio to a LocalAI server running vibevoice.cpp for transcription and speaker diarization. - Sends audio to a LocalAI server running vibevoice.cpp for transcription and speaker diarization.
- Optionally uses a second LLM to generate a detailed, structured summary. - Optionally uses a second LLM to generate a structured summary.
- Provides: - Provides:
- A web GUI for uploading audio and receiving transcripts via email. - A web GUI for uploading audio and receiving transcripts via email.
- A CLI and Python API for direct integration. - A CLI and Python API for direct integration.
@@ -29,12 +29,12 @@ For more information: https://apstrom.ca
- Jobs are queued and processed in the background (Celery + Redis). - Jobs are queued and processed in the background (Celery + Redis).
- Emails: - Emails:
- Immediate confirmation with queue position. - Immediate confirmation with queue position.
- Final transcript (MD + JSON) when ready. - Final transcript (MD + DOCX + JSON) when ready.
- Summary as MD file (if requested). - Summary as MD + DOCX (if requested).
- Error notification if processing fails. - Error notification if processing fails.
- File formats: - File formats:
- Transcript: .md and .docx - Transcript: .md and .docx (line-numbered, no cover page)
- Summary (if requested): .md and .docx - Summary (if requested): .md and .docx (no line numbering, no cover page)
- Full structured output: .json - Full structured output: .json
- Customizable branding: - Customizable branding:
- Web GUI title, logo, and accent color via environment variables. - Web GUI title, logo, and accent color via environment variables.
@@ -256,12 +256,13 @@ Email subject lines (customizable):
Output files (async web GUI): Output files (async web GUI):
When a job completes, the user receives: When a job completes, the user receives:
- Transcript: - Transcript:
- .md file - .md file
- .docx file - .docx file (line-numbered, no cover page)
- Summary (if requested): - Summary (if requested):
- .md file - .md file
- .docx file - .docx file (no line numbering, no cover page)
- JSON: - JSON:
- Structured transcript with diarization and metadata - Structured transcript with diarization and metadata