diff --git a/README.md b/README.md index c1f8774..2eff451 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,9 @@ -[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) -

Project logo

+[![](https://dcbadge.limes.pink/api/server/YuMNeuKStr?style=flat)](https://discord.gg/YuMNeuKStr) +[![Docs](https://github.com/mozilla-ai/document-to-podcast/actions/workflows/docs.yaml/badge.svg)](https://github.com/mozilla-ai/document-to-podcast/actions/workflows/docs.yaml/) +[![Tests](https://github.com/mozilla-ai/document-to-podcast/actions/workflows/tests.yaml/badge.svg)](https://github.com/mozilla-ai/document-to-podcast/actions/workflows/tests.yaml/) +[![Ruff](https://github.com/mozilla-ai/document-to-podcast/actions/workflows/lint.yaml/badge.svg?label=Ruff)](https://github.com/mozilla-ai/document-to-podcast/actions/workflows/lint.yaml/) + +

Project logo

# Document-to-podcast: a Blueprint by Mozilla.ai for generating podcasts from documents using local AI @@ -8,6 +12,13 @@ It is designed to work on most local setups or with [GitHub Codespaces](https:// ### 👉 📖 For more detailed guidance on using this project, please visit our [Docs here](https://mozilla-ai.github.io/document-to-podcast/). +### Built with +- Python 3.10+ +- [Llama-cpp](https://github.com/abetlen/llama-cpp-python) (text-to-text, i.e script generation) +- [Parler_tts](https://github.com/huggingface/parler-tts) (text-to-speech, i.e audio generation) +- [Streamlit](https://streamlit.io/) (UI demo) + + ## Quick-start Get started with Document-to-Podcast using one of the two options below: **GitHub Codespaces** for a hassle-free setup or **Local Installation** for running on your own machine. diff --git a/docs/future-features-contributions.md b/docs/future-features-contributions.md index 9223ae7..e91d951 100644 --- a/docs/future-features-contributions.md +++ b/docs/future-features-contributions.md @@ -6,7 +6,7 @@ The Document-to-Podcast Blueprint is an evolving project designed to grow with t ## 🛠️ **This Page is Evolving** As the community grows, we’ll use this space to highlight contributions, showcase new ideas, and share guidance on expanding the Blueprint ecosystem. -We have some ideas of how this Blueprint can be extend and improved, will be sharing these ideas and request for contributions shortly. +We have some ideas of how this Blueprint can be extended and improved, will be sharing these ideas and request for contributions shortly. --- diff --git a/docs/index.md b/docs/index.md index e0ea982..be5eef0 100644 --- a/docs/index.md +++ b/docs/index.md @@ -6,7 +6,14 @@ Blueprints empower developers to easily integrate AI capabilities into their projects using open-source models and tools. -These docs are your your companion to mastering the **Document-to-Podcast Blueprint**—a local-first approach for transforming documents into engaging podcasts. +These docs are your companion to mastering the **Document-to-Podcast Blueprint**—a local-first approach for transforming documents into engaging podcasts. + +### Built with +- Python 3.10+ +- [Llama-cpp](https://github.com/abetlen/llama-cpp-python) (text-to-text, i.e script generation) +- [Parler_tts](https://github.com/huggingface/parler-tts) (text-to-speech, i.e audio generation) +- [Streamlit](https://streamlit.io/) (UI demo) + ---