Skip to content

Commit

Permalink
Add badges & built with section (#39)
Browse files Browse the repository at this point in the history
* Add badges

* Add built with section

* Add built with section in index.md

* Fix typo

* Fix badge label

* Make logo a bit bigger

* Remove unnecessary badges
  • Loading branch information
Kostis-S-Z authored Dec 5, 2024
1 parent 33d2d14 commit 1752e2e
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 4 deletions.
15 changes: 13 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
<p align="center"><img src="./images/Blueprints-logo.png" width="25%" alt="Project logo"/></p>
[![](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/)

<p align="center"><img src="./images/Blueprints-logo.png" width="35%" alt="Project logo"/></p>

# Document-to-podcast: a Blueprint by Mozilla.ai for generating podcasts from documents using local AI

Expand All @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion docs/future-features-contributions.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

---

Expand Down
9 changes: 8 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)


---

Expand Down

0 comments on commit 1752e2e

Please sign in to comment.