Go to file
Franziska Kunsmann 3f7649b09a remove githubs "release on tag" action 2023-03-01 11:33:46 +01:00
.github/workflows remove githubs "release on tag" action 2023-03-01 11:33:46 +01:00
img add more info to README 2021-11-21 08:41:30 +01:00
pretalx_broadcast_tools room info: add option to hide qr code or show the submission image 2023-03-01 11:29:56 +01:00
.gitignore initial commit 2021-11-20 09:05:08 +01:00
CHANGELOG.md Version 1.0.3 2022-11-07 06:45:21 +01:00
LICENSE LICENSE: fix my name 2021-11-21 08:25:44 +01:00
MANIFEST.in make the linter happy 2022-11-07 04:27:00 +01:00
Makefile initial commit 2021-11-20 09:05:08 +01:00
README.rst update README 2023-02-28 19:19:47 +01:00
setup.cfg adjust ci settings to match pretalx settings 2021-11-21 13:30:12 +01:00
setup.py release 1.1.0 2023-02-28 19:20:43 +01:00

README.rst

Pretalx: Broadcast Tools (and more)
==========================

This is a plugin for `pretalx`_.

This adds the following features to your pretalx instance:

* Lower Thirds ("Bauchbinden") for using with something like OBS
* a "room info" screen, if you want to show information about the
  currently running talk outside the room
* a pdf export containing information about a talk, so video helpers
  can have easy access to the needed information

Development setup
-----------------

1. Make sure that you have a working `pretalx development setup`_.

2. Clone this repository, eg to ``local/pretalx-plugin-lower-thirds``.

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.

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 the 'plugins' tab
   in the settings.


License
-------

Copyright 2021 Franziska 'kunsi' Kunsmann

Released under the terms of the Apache License 2.0


.. _pretalx: https://github.com/pretalx/pretalx
.. _pretalx development setup: https://docs.pretalx.org/en/latest/developer/setup.html
.. _OBS Studio: https://obsproject.com/