doc: add development insctuctions
Parent
026af7203f
révision
e9ef6d1be2
19
README.md
19
README.md
|
@ -1,3 +1,22 @@
|
|||
# wagtail-webradio
|
||||
|
||||
Manage a webradio (podcats, programs...) in a wagtail website.
|
||||
|
||||
## Development
|
||||
|
||||
To setup a development environment, clone this repository and follow the
|
||||
installation steps but replace the installation from PyPi by:
|
||||
|
||||
```shell
|
||||
pip install -e .[test]
|
||||
```
|
||||
|
||||
The Python code is formatted and linted thanks to flake8, isort and black. To
|
||||
ease the use of this tools, the following commands are available:
|
||||
- `make lint`: check the Python code syntax and imports order
|
||||
- `make format`: fix the Python code syntax and imports order
|
||||
|
||||
## License
|
||||
|
||||
This extension is mainly developed by [Cliss XXI](https://www.cliss21.com) and
|
||||
licensed under the [AGPLv3+](LICENSE). Any contribution is welcome!
|
||||
|
|
|
@ -1,6 +1,8 @@
|
|||
[metadata]
|
||||
name = wagtail-webradio
|
||||
description = manage podcats, webradio programs and more in a wagtail website
|
||||
long_description = file: README.md
|
||||
long_description_content_type = text/markdown
|
||||
author = Cliss XXI
|
||||
author_email = contact@cliss21.com
|
||||
license = AGPLv3+
|
||||
|
|
Référencer dans un nouveau ticket