novaburst/funquail
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Clean up documentation

Browse source
This commit is contained in:
Ciarán Ainsworth 2022-10-26 22:07:02 +02:00 • committed by Georg Krause
commit dfa73631c7
16 changed files with 836 additions and 1014 deletions
Download patch file Download diff file Expand all files Collapse all files

26
README.md Normal file
View file

@ -0,0 +1,26 @@
# Funkwhale
[![The Funkwhale logo](./front/src/assets/logo/logo-full-500.png)](https://funkwhale.audio)
Funkwhale is a platform for uploading, sharing, and publishing audio content across the federated web. Curate your music library, listen to podcasts, or create your own content and share it with the world.
## Contribute
Want to help make Funkwhale even better? We welcome contributions from across the community. Whether you are a designer, a translator, a technical writer, or a developer, we look forward to seeing your work!
You can find contribution information in our [documentation hub](https://docs.funkwhale.audio).
- [Developer guides](https://docs.funkwhale.audio/developer_documentation/index.html)
- [Contributor guides](https://docs.funkwhale.audio/contributor_documentation/index.html)
## Get help
Got a question or need help? Head over to our [forum](https://forum.funkwhale.audio/t/support) and open up a discussion.
## Report a security issue
If you find a security issue or vulnerability, please report it on our [GitLab instance](https://dev.funkwhale.audio/funkwhale/funkwhale/-/issues). When you open your issue, select the **This issue is confidential and should only be visible to team members with at least Reporter access** option. This ensures developers can verify and patch the issue before disclosing it.
## Code of conduct
The Funkwhale collective adheres to a [code of conduct](https://funkwhale.audio/en_US/code-of-conduct) in all our community spaces. Please familiarize yourself with this code and follow it when participating in discussions in our spaces.