mirror of
https://github.com/Kunsi/pretalx-plugin-broadcast-tools
synced 2024-11-24 10:21:01 +00:00
add more info to README
This commit is contained in:
parent
4b71ac112e
commit
35bccfc3cb
3 changed files with 31 additions and 5 deletions
36
README.rst
36
README.rst
|
@ -1,7 +1,30 @@
|
||||||
Lower Thirds
|
Lower Thirds
|
||||||
==========================
|
==========================
|
||||||
|
|
||||||
This is a plugin for `pretalx`_.
|
This is a plugin for `pretalx`_.
|
||||||
|
|
||||||
|
This plugin allows you to add configurable lower thirds ("Bauchbinden"
|
||||||
|
in German) to your pretalx instance. Most likely this will be used in
|
||||||
|
(for example) a Browser Source inside `OBS Studio`_.
|
||||||
|
|
||||||
|
.. image:: img/lower_thirds.png
|
||||||
|
:width: 400
|
||||||
|
:alt: Screenshot of the lower third output. There's currently a talk running.
|
||||||
|
|
||||||
|
The colours will be automatically determined from the event and track
|
||||||
|
colours set inside pretalx.
|
||||||
|
|
||||||
|
You can also add a configurable third line to the lower thirds, for
|
||||||
|
example to hint your audience to vote for the talks. To make this easier,
|
||||||
|
the plugin will automatically replace some placeholders inside the text,
|
||||||
|
so you can have individual text for all talks.
|
||||||
|
|
||||||
|
.. image:: img/orga_view.png
|
||||||
|
:width: 400
|
||||||
|
:alt: Screenshot of the orga view
|
||||||
|
|
||||||
|
Inside the orga view, you can also configure the text snippet that's
|
||||||
|
shown if there's no talk running currently.
|
||||||
|
|
||||||
Development setup
|
Development setup
|
||||||
-----------------
|
-----------------
|
||||||
|
@ -12,21 +35,24 @@ Development setup
|
||||||
|
|
||||||
3. Activate the virtual environment you use for pretalx development.
|
3. Activate the virtual environment you use for pretalx development.
|
||||||
|
|
||||||
4. Execute ``python setup.py develop`` within this directory to register this application with pretalx's plugin registry.
|
4. Execute ``python setup.py develop`` within this directory to register
|
||||||
|
this application with pretalx's plugin registry.
|
||||||
|
|
||||||
5. Execute ``make`` within this directory to compile translations.
|
5. Execute ``make`` within this directory to compile translations.
|
||||||
|
|
||||||
6. Restart your local pretalx server. You can now use the plugin from this repository for your events by enabling it in
|
6. Restart your local pretalx server. You can now use the plugin from
|
||||||
the 'plugins' tab in the settings.
|
this repository for your events by enabling it in the 'plugins' tab
|
||||||
|
in the settings.
|
||||||
|
|
||||||
|
|
||||||
License
|
License
|
||||||
-------
|
-------
|
||||||
|
|
||||||
Copyright 2021 kunsi
|
Copyright 2021 Franziska 'kuns' Kunsmann
|
||||||
|
|
||||||
Released under the terms of the Apache License 2.0
|
Released under the terms of the Apache License 2.0
|
||||||
|
|
||||||
|
|
||||||
.. _pretalx: https://github.com/pretalx/pretalx
|
.. _pretalx: https://github.com/pretalx/pretalx
|
||||||
.. _pretalx development setup: https://docs.pretalx.org/en/latest/developer/setup.html
|
.. _pretalx development setup: https://docs.pretalx.org/en/latest/developer/setup.html
|
||||||
|
.. _OBS Studio: https://obsproject.com/
|
||||||
|
|
BIN
img/lower_thirds.png
Normal file
BIN
img/lower_thirds.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 27 KiB |
BIN
img/orga_view.png
Normal file
BIN
img/orga_view.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 87 KiB |
Loading…
Reference in a new issue