|
1 | | -<img src="https://raw.githubusercontent.com/shabados/presenter/dev/resources/icon.png" width="128" alt="Shabad OS"> |
2 | | - |
3 | 1 | # Theme Tool |
4 | 2 |
|
5 | 3 | Overlay generator for Shabad OS Presenter. [Create a custom live stream overlay >](https://themes.shabados.com/) |
6 | 4 |
|
7 | | -[![Release][release-image]][release-url] |
8 | | -[![Next Release][next-image]][next-url] |
| 5 | +[](https://github.com/shabados/theme-tool/actions/workflows/deploy.yml) |
9 | 6 | <a href="https://vercel.com/?utm_source=ShabadOS&utm_campaign=oss"> |
10 | | -<img src="https://www.datocms-assets.com/31049/1618983297-powered-by-vercel.svg" width="100" alt="Powered by Vercel"/> |
| 7 | +<img src="https://www.datocms-assets.com/31049/1618983297-powered-by-vercel.svg" height="20" alt="Powered by Vercel"/> |
11 | 8 | </a> |
12 | 9 |
|
13 | | -- [Introduction](#introduction) |
14 | | - - [Features](#features) |
15 | | - - [Screenshots](#screenshots) |
16 | | - - [Changing text color in Theme Tool](#changing-text-color-in-theme-tool) |
17 | | - - [Viewing Overlay settings in Presenter](#viewing-overlay-settings-in-presenter) |
18 | | - - [Example Live Stream with Overlay captions](#example-live-stream-with-overlay-captions) |
19 | | -- [Community](#community) |
20 | | -- [Contributing](#contributing) |
21 | | -- [People](#people) |
22 | | -- [Feedback](#feedback) |
23 | | -- [Related Projects](#related-projects) |
24 | | -- [Code of Conduct](#code-of-conduct) |
25 | | -- [License](#license) |
26 | | - |
27 | | -## Introduction |
28 | | - |
29 | | -The Shabad OS Theme Tool is an open source project with ongoing development, project management, and marketing made possible entirely by the support and dedication of unpaid volunteers. |
| 10 | +## About |
30 | 11 |
|
31 | 12 | This web app allows users to customize and generate overlays in Shabad OS Presenter. Overlays are in sync with the presenter, so what is displayed there will also show up in the overlay. Overlays should be used in live streaming software to add gurbani and/or english, hindi, punjabi translations / pronunciations. |
32 | 13 |
|
33 | 14 | See: |
34 | 15 |
|
35 | | -- [Our Website][website-url] |
36 | | -- [How to install Presenter](https://tutorials.shabados.com/tutorials/1.0.0/basics/install.html) |
37 | | -- [How to add live stream captions](https://tutorials.shabados.com/tutorials/1.0.0/overlay/add-live-streaming-captioning.html) |
| 16 | +- [Installing Shabad OS Presenter](https://docs.shabados.com/presenter/guides/installing-shabad-os-presenter) |
| 17 | +- [Configuring Live Stream Captions](https://docs.shabados.com/presenter/guides/configuring-live-stream-captions) |
| 18 | +- [Importing an overlay theme](https://docs.shabados.com/presenter/guides/importing-an-overlay-theme) |
38 | 19 |
|
39 | 20 | ### Features |
40 | 21 |
|
|
60 | 41 |
|
61 | 42 | ## Community |
62 | 43 |
|
63 | | -Get updates on Shabad OS and chat with the project maintainers and community members. |
64 | | - |
65 | | -- [![Instagram][instagram-image]][instagram-url] Follow Shabad OS on Instagram |
66 | | -- [![Twitter][twitter-image]][twitter-url] Follow Shabad OS on Twitter. |
67 | | -- [![Chat][chat-image]][chat-url] Join the official Slack channel. |
68 | | - |
69 | | -## Contributing |
70 | | - |
71 | | -There are multiple ways to contribute whether you are a user or developer. For example: |
72 | | - |
73 | | -- [Submit bugs and feature requests][new-issue-url]. |
74 | | -- Review documentation and make pull requests for anything from typos to new content. |
75 | | -- Give feedback on the onboarding process to make it easier for others to join the project. |
76 | | - |
77 | | -If you're interested in contributing to the source code of Theme Tool, then please see [Contributing Guidelines](./CONTRIBUTING.md). |
78 | | - |
79 | | -## People |
| 44 | +The easiest way to communicate is via [GitHub issues](https://github.com/shabados/viewer/issues). Please search for similar issues regarding your concerns before opening a new issue. |
80 | 45 |
|
81 | | -The original author and current lead maintainer is Saihajpreet Singh ([@saihaj](https://github.com/saihaj)). |
| 46 | +Get organization updates for Shabad OS by following us on [Instagram](https://www.instagram.com/shabad_os/) and [Twitter](https://twitter.com/shabad_os/). We also invite you to join us on our public chat server hosted on [Slack](https://chat.shabados.com/). |
82 | 47 |
|
83 | | -"Thank you!" to [all the volunteers][contributor-url] who've contributed to Theme Tool. |
| 48 | +Our intention is to signal a safe open-source community. Please help us foster an atmosphere of kindness, cooperation, and understanding. By participating, you agree to abide by the [Contributor Covenant](https://www.contributor-covenant.org/version/2/0/code_of_conduct/). |
84 | 49 |
|
85 | | -## Feedback |
| 50 | +If you have a concern that doesn't warrant opening a GitHub issue, please reach out to us: |
86 | 51 |
|
87 | | -- Ask questions and get help in our community chat via [Slack][chat-url] |
88 | | -- [Upvote popular feature requests][upvote-tracker-url] using the thumbs-up/+1 reaction on the first post of a feature request |
89 | | -- Follow [@shabad_os on Instagram](instagram-url) and [@shabad_os on Twitter](twitter-url) and let us know what you think! |
| 52 | +Saihajpreet Singh, Author, Maintainer: [@saihaj](https://github.com/saihaj) |
90 | 53 |
|
91 | | -## Related Projects |
92 | | - |
93 | | -Projects in the Shabad OS ecosystem of free and open source software include: |
94 | | - |
95 | | -- [Database](https://github.com/shabados/database) |
96 | | -- [Viewer](https://github.com/shabados/viewer) |
97 | | -- [Presenter](https://github.com/shabados/presenter) |
98 | | -- [Mobile](https://github.com/shabados/mobile) |
99 | | -- [Gurmukhi Utils](https://github.com/shabados/gurmukhi-utils) |
100 | | - |
101 | | -## Code of Conduct |
102 | | - |
103 | | -Please note that this project is released under the Contributor Covenant. By participating in this project you agree to abide by its terms. Our intention is to signal a safe open-source community by welcoming all people to contribute, and pledging in return to value them as whole human beings and to foster an atmosphere of kindness, cooperation, and understanding. |
104 | | - |
105 | | -> We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation. |
106 | | -> |
107 | | -> We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community. |
108 | | -> |
109 | | -> [The Contributor Covenant][contributor-covenant-url] |
110 | | -
|
111 | | -## License |
112 | | - |
113 | | -This project is under v3 of the [GPL](LICENSE.md). It is similar to the Golden Rule: do unto others as you would have them do unto you. In exchange for benefitting from the work completed in this repo, others must share their derivative work under v3 of the [GPL](LICENSE.md). |
114 | | - |
115 | | -> This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. |
116 | | -> |
117 | | -> This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. |
118 | | -> |
119 | | -> You should have received a copy of the GNU General Public License along with this program. If not, see <https://www.gnu.org/licenses/>. |
| 54 | +## Contributing |
120 | 55 |
|
121 | | -[release-image]: https://img.shields.io/github/workflow/status/shabados/theme-tool/Build%20and%20Deploy/master.svg?label=release |
122 | | -[release-url]: https://github.com/shabados/theme-tool/actions?query=workflow%3A%22Build+and+Deploy%22+branch%3Amaster |
123 | | -[next-image]: https://img.shields.io/github/workflow/status/shabados/theme-tool/Build%20and%20Deploy/dev.svg?label=next%20release |
124 | | -[next-url]: https://github.com/shabados/theme-tool/actions?query=workflow%3A%22Build+and+Deploy%22+branch%3Adev |
125 | | -[website-url]: https://shabados.com |
126 | | -[instagram-image]: https://img.shields.io/badge/Instagram-%40shabad__os-C13584.svg?logo=instagram&logoColor=white |
127 | | -[instagram-url]: https://www.instagram.com/shabad_os/ |
128 | | -[twitter-image]: https://img.shields.io/badge/Twitter-%40shabad__os-1DA1F2.svg?logo=twitter&logoColor=white |
129 | | -[twitter-url]: https://www.twitter.com/shabad_os/ |
130 | | -[chat-image]: https://img.shields.io/badge/Chat-Public%20Slack%20Channels-1264a3.svg?logo=slack |
131 | | -[chat-url]: https://chat.shabados.com |
132 | | -[new-issue-url]: https://github.com/shabados/theme-tool/issues/new/choose |
133 | | -[contributor-url]: https://github.com/shabados/theme-tool/graphs/contributors |
134 | | -[upvote-tracker-url]: https://github.com/shabados/theme-tool/issues?q=is%3Aopen+is%3Aissue+label%3A%22Type%3A+Feature%2FEnhancement%22+sort%3Areactions-%2B1-desc |
135 | | -[contributor-covenant-url]: https://www.contributor-covenant.org/version/2/0/code_of_conduct/ |
| 56 | +Please see [CONTRIBUTING.md](/CONTRIBUTING.md). |
0 commit comments