Skip to content
Snippets Groups Projects
Normal view Permalink
README.rst 1.13 KiB
Newer Older
  • Learn to ignore specific revisions
    • Eliot Berriot's avatar
    Initial commit that merge both the front end and the API in the same repository
    Eliot Berriot committed
    1 2 3 
    Funkwhale
=============
    Eliot Berriot's avatar
    Readme tweaks / logo  
    Eliot Berriot committed
    4 5 6 7 
    .. image:: ./front/src/assets/logo/logo-full-500.png
  :alt: Funkwhale logo
  :target: https://funkwhale.audio
    Eliot Berriot's avatar
    Initial commit that merge both the front end and the API in the same repository
    Eliot Berriot committed
    8 9 
    A self-hosted tribute to Grooveshark.com.
    R En's avatar
    fix license on README  
    R En committed
    10 
    LICENSE: AGPL3
    Eliot Berriot's avatar
    Initial commit that merge both the front end and the API in the same repository
    Eliot Berriot committed
    11
    Eliot Berriot's avatar
    Fixed #123: up-to-date and complete development and contribution instructions in README.rst  
    Eliot Berriot committed
    12 13 
    Getting help
------------
    Eliot Berriot's avatar
    Initial commit that merge both the front end and the API in the same repository
    Eliot Berriot committed
    14
    Eliot Berriot's avatar
    Readme tweaks / logo  
    Eliot Berriot committed
    15 
    We offer various Matrix.org rooms to discuss about Funkwhale:
    Eliot Berriot's avatar
    Initial commit that merge both the front end and the API in the same repository
    Eliot Berriot committed
    16
    Jan Christian Grünhage's avatar
    Replace riot.im links with matrix.to links  
    Jan Christian Grünhage committed
    17 18 
    - `#funkwhale:matrix.org <https://matrix.to/#/#funkwhale:matrix.org>`_ for general questions about funkwhale
- `#funkwhale-dev:matrix.org <https://matrix.to/#/#funkwhale-dev:matrix.org>`_ for development-focused discussion
    Eliot Berriot's avatar
    Fixed #123: up-to-date and complete development and contribution instructions in README.rst  
    Eliot Berriot committed
    19 20 21 
    
Please join those rooms if you have any questions!
    Eliot Berriot's avatar
    Readme tweaks / logo  
    Eliot Berriot committed
    22 23 24 
    You can also contact `@funkwhale@mastodon.eliotberriot.com <https://mastodon.eliotberriot.com/@funkwhale>`_ on the fediverse.
    Eliot Berriot's avatar
    Added contribution documentation  
    Eliot Berriot committed
    25 26 
    Contribute
----------
    Eliot Berriot's avatar
    Fixed #123: up-to-date and complete development and contribution instructions in README.rst  
    Eliot Berriot committed
    27
    Eliot Berriot's avatar
    Added contribution documentation  
    Eliot Berriot committed
    28 
    Contribution guidelines as well as development installation instructions
    Thomas Citharel's avatar
    Rename CONTRIBUTING to CONTRIBUTING.rst for Gitlab formatting preview.  
    Thomas Citharel committed
    29 
    are outlined in `CONTRIBUTING <CONTRIBUTING.rst>`_.
    Eliot Berriot's avatar
    See #161: added initial translating guidelines  
    Eliot Berriot committed
    30 31 32 33 
    
Translate
^^^^^^^^^
    Jo Vuit's avatar
    Rename TRANSLATORS to TRANSLATORS.rst for Gitlab formatting preview  
    Jo Vuit committed
    34 
    Translators willing to help can refer to `TRANSLATORS <TRANSLATORS.rst>`_ for instructions.
    Eliot Berriot's avatar
    Merge branch 'develop' into 'coc'  
    Eliot Berriot committed
    35 36 37 38 39 
    
Code of Conduct
---------------

`Our Code of Conduct <https://funkwhale.audio/code-of-conduct/>`_ applies to all the community spaces, including our GitLab instance. Please, take a moment to read it.