feat: Update readme.md

Update readme.md with better instructions.
2026-10-29 11:51:10 -03:00
parent 16247f45cc
commit 2a1a992dfa
8 changed files with 660 additions and 7 deletions
@@ -1,3 +1,18 @@
-hf auth login
+# Phonon-40-es

-The safe tensor file (the x6lttij... file) is for the voice of manito. Phonon uses that to cloning the voice and using it for audio and streaming.
+## Just in case:
+*The safe tensor file (the x6lttij... file) is for the voice of manito. Phonon uses that to cloning the voice and using it for audio and streaming.*
+
+## Before running.
+
+This model of Phonon-40-es calls huggingface as its a gated model, so you need access it and ask for permition to use it.  
+This is the link. ```https://huggingface.co/gradium/phonon-40m-es```
+
+## Setup
+Copy `env.example` to `.env` and then add your Hugging Face token as `HF_TOKEN`. When you run `main.py`, it loads `.env` automatically from the same folder; you do not need to set the environment variable manually in the console.
+
+```
+cp env.example .env
+uv sync
+uv run python main.py
+```