Supporta il progetto

Prima di tutto: grazie mille per dedicare il tuo tempo a contribuire a questa applicazione!

Songpress è ospitato su Github e puoi aiutare il progetto in diversi modi:

segnalando bug o suggerendo miglioramenti tramite il nostro issue tracker su Github
creando nuove traduzioni
fornendo materiale grafico (icone, pulsanti, ecc.)
contribuendo al codice, effettuando un fork del repository e inviando una pull request
contribuendo alla documentazione

Contribuire alla documentazione

Il sito della documentazione di Songpress è scritto in Markdown e generato tramite i seguenti strumenti:

Il generatore di siti statici mkdocs
mkdocs-material per il tema e per funzionalità non incluse in mkdocs
mkdocs-static-i18n per localizzare il sito in diverse lingue (al momento sono disponibili l'inglese e l'italiano)

Configurazione dell'ambiente

Markdown è un semplice formato testuale, quindi puoi scrivere la documentazione utilizzando un qualsiasi editor di testo. Tuttavia, probabilmente vorrai compilare ed eseguire localmente il sito della documentazione di Songpress, in modo da poter verificare il tuo contributo prima di inviare una pull request.

Per prima cosa, assicurati che Python sia installato sul tuo computer. Apri una shell ed esegui: python --version. Se Python è installato correttamente, otterrai un output simile al seguente: Python 3.12.3

Successivamente, crea un ambiente virtuale per Songpress e attivalo (supponendo che la directory dedicata agli ambienti virtuali sia .venv):

python -m venv .venv/songpress

source .venv/songpress/bin/activate

Quindi installa tutti gli strumenti necessari tramite pip:

pip install mkdocs mkdocs-material mkdocs-static-i18n

Perfetto! Ora sei pronto per eseguire il sito della documentazione.

Effettua un fork del repository, clonalo in locale e, dalla directory principale del progetto, esegui il comando mkdocs serve.

A questo punto, aprendo nel browser l'indirizzo http://localhost:8000, potrai visualizzare il sito della documentazione.

Il comando serve di MkDocs aggiorna automaticamente il sito ogni volta che modifichi uno dei documenti oppure il file di configurazione mkdocs.yml.