From bbc9ccc3d93ce07b8a2521649147101022a1e761 Mon Sep 17 00:00:00 2001 From: cv <34649812+cpvalente@users.noreply.github.com> Date: Mon, 14 Jun 2021 14:19:50 +0200 Subject: [PATCH] Update README.md --- README.md | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) diff --git a/README.md b/README.md index 1a2d8504f..51d547126 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,37 @@ [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-green.svg)](https://www.gnu.org/licenses/gpl-3.0) + +# Ontime +Ontime is an application for managing and running stage timers. + +It allows a center application to be able to distribute event information in the local network. This minimises needs for using Media Server outputs or expensive video distribution while allowing easy integration in workflows including OBS and d3. + +## Feature List +- Distribute Data over network and render in the browser +- Different screen types + - Stage Timer + - Backstage Info + - Public Info + - Picture in Picture +- Configurable realtime Lower Thirds +- Ability to differentiate between backstage and public data +- OSC Control and Feedback +- Roll mode: run independently from system clock + +## Roadmap +### For version 1 +Almost reaching a feature set that we can call v1. Before that: +- [ ] Mac OS version +- [ ] Finish Documentation +### Continuing +- [ ] Linux version +- [ ] Companion integration +- [ ] Lower Third Manager +- [ ] URL Aliases (define configurable aliases to ease onsite setup) +- [ ] Logging view +- [ ] Reach Schedule: way to speedup timer to meet a deadline + +# Help +Help is underway! ... and can be viewed [here](https://cpvalente.gitbook.io/ontime/) + # License This project is licensed under the terms of the GNU GPL v3 \ No newline at end of file