diff --git a/01_app.png b/01_app.png new file mode 100644 index 000000000..b928e6a52 Binary files /dev/null and b/01_app.png differ diff --git a/02_screentypes.png b/02_screentypes.png new file mode 100644 index 000000000..7e7b2c1e3 Binary files /dev/null and b/02_screentypes.png differ diff --git a/README.md b/README.md index 1a2d8504f..dc3e95848 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,42 @@ [![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. + +![App Window](https://github.com/cpvalente/ontime/01_app.png) + +![Views](https://github.com/cpvalente/ontime/02_screentypes.png) +## Feature List (in no specific order) +- 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 +- Send live messages to different screen types +- Ability to differentiate between backstage and public data +- Manage delays workflow +- 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 diff --git a/SUMMARY.md b/SUMMARY.md deleted file mode 100644 index 5da1733df..000000000 --- a/SUMMARY.md +++ /dev/null @@ -1,4 +0,0 @@ -# Table of contents - -* [Initial page](README.md) -