From 9fac6125d804b2f8ccc2c1dbdcb5ab3f7085bddf Mon Sep 17 00:00:00 2001 From: "Bhajneet S.K" Date: Thu, 16 Jun 2022 14:55:36 -0400 Subject: [PATCH] docs: update readme and contributing --- CONTRIBUTING.md | 69 ++++++------------------------- README.md | 105 ++++++------------------------------------------ 2 files changed, 26 insertions(+), 148 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 55bd94b..d322d79 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,77 +1,34 @@ -# Contributing to Theme Tool +# Contributing Code Thank you for your interest in participating! -There are many ways to contribute, beyond writing code or programming, by: logging bugs, reporting issues, and creating suggestions. To do so, please [create a ticket](https://github.com/shabados/theme-tool/issues/new/choose) in our issue tracker. See other ways to [Contribute](README.md#Contributing) or give [Feedback](README.md#Feedback). +There are many ways to contribute, beyond writing code or programming, by: asking questions, reporting bugs, and suggesting features. To do so, please log a [new issue](https://github.com/shabados/theme-tool/issues/new). -This document is for developers or programmers contributing to the source code of Theme Tool. +**This document is for developers or programmers contributing to the source code.** -**Table of Contents** +## Get Started -- [Getting Started](#getting-started) - - [Prerequisites](#prerequisites) - - [Build](#build) - - [Start](#start) -- [Workflow](#workflow) - - [Coding Guidelines](#coding-guidelines) - - [Scope](#scope) -- [Thank you](#thank-you) - -## Getting Started - -If you wish to better understand how `theme-tool` works or want to debug an issue: get the source, build it, and run it locally. - -### Prerequisites - -In order to download necessary tools, clone the repository, and install dependencies, you'll need network access. - -You'll need the following: +**Prerequisites** - [Git](https://git-scm.com/) -- [Node.JS](https://nodejs.org) (If you need to manage multiple Node.JS versions, [use a node version manager](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) to install) +- [Node.JS](https://nodejs.org) + +**Development** -Get the source code of `theme-tool` repo: +Get the source code of `theme-tool` repo. Our recommended approach is to use the [`gh` cli tool from GitHub](https://cli.github.com/). This will fork the repo to your GitHub account (if not already), clone it to your local machine, and set the appropriate remotes for origin and upstream with the above command. ```shell gh repo fork shabados/theme-tool --clone=true ``` -**PROTIP**: Use the [`gh` cli tool from GitHub](https://cli.github.com/) to fork the repo to your GitHub account (if not already), clone it to your local machine, and set the appropriate remotes for origin and upstream with the above command. - -### Build - Run `npm i` in the root directory. -### Start - -```shell -npm start -``` - -This will launch Theme Tool on [port `3000`](https://localhost:3000). - -## Workflow - -The workflow of development (or Git Flow) is to [choose/create an issue](https://github.com/shabados/theme-tool/issues) to work on, [create a feature branch](https://github.com/shabados/.github/wiki/How-to-Contribute#branches), and [submit a pull request](https://github.com/shabados/.github/wiki/How-to-Contribute#pull-requests). - -**PROTIP**: Read more about our workflow (issue tracking, branching, and pull requests) in the [How To Contribute wiki article](https://github.com/shabados/.github/wiki/How-to-Contribute). - -### Coding Guidelines - -Please see the [wiki](https://github.com/shabados/.github/wiki/How-to-Contribute#coding-guidelines) for Coding Guidelines ([Names](https://github.com/shabados/.github/wiki/How-to-Contribute#41-names), [Comments](https://github.com/shabados/.github/wiki/How-to-Contribute#42-comments), [Style](https://github.com/shabados/.github/wiki/How-to-Contribute#43-style), [Linting](https://github.com/shabados/.github/wiki/How-to-Contribute#44-linting), and [Commit Messages](https://github.com/shabados/.github/wiki/How-to-Contribute#45-commit-messages)). +Use `npm start` to launch Theme Tool on [port `3000`](https://localhost:3000). -### Scope - -To be used in [commit messages](https://github.com/shabados/.github/wiki/How-to-Contribute#45-commit-messages). - -Usage: - -```shell -(): -``` +## Contributing -There are no scopes for this repo. +Please see our organization docs on [contributing](https://docs.shabados.com/community/). These cover important aspects including workflow (how to submit a PR), coding guidelines (how to write a commit message), and project management (latest/next release information). ## Thank you -Your contributions to open source, large or small, make great projects like this possible. Thank you for taking the time to participate in this project. +Your contributions to open source, large or small, make great projects like this possible. Thank you for taking the time to participate in this project! diff --git a/README.md b/README.md index ba6451e..04113ae 100644 --- a/README.md +++ b/README.md @@ -1,40 +1,21 @@ -Shabad OS - # Theme Tool Overlay generator for Shabad OS Presenter. [Create a custom live stream overlay >](https://themes.shabados.com/) -[![Release][release-image]][release-url] -[![Next Release][next-image]][next-url] +[![Build and Deploy](https://github.com/shabados/theme-tool/actions/workflows/deploy.yml/badge.svg?branch=master)](https://github.com/shabados/theme-tool/actions/workflows/deploy.yml) -Powered by Vercel +Powered by Vercel -- [Introduction](#introduction) - - [Features](#features) - - [Screenshots](#screenshots) - - [Changing text color in Theme Tool](#changing-text-color-in-theme-tool) - - [Viewing Overlay settings in Presenter](#viewing-overlay-settings-in-presenter) - - [Example Live Stream with Overlay captions](#example-live-stream-with-overlay-captions) -- [Community](#community) -- [Contributing](#contributing) -- [People](#people) -- [Feedback](#feedback) -- [Related Projects](#related-projects) -- [Code of Conduct](#code-of-conduct) -- [License](#license) - -## Introduction - -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. +## About 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. See: -- [Our Website][website-url] -- [How to install Presenter](https://tutorials.shabados.com/tutorials/1.0.0/basics/install.html) -- [How to add live stream captions](https://tutorials.shabados.com/tutorials/1.0.0/overlay/add-live-streaming-captioning.html) +- [Installing Shabad OS Presenter](https://docs.shabados.com/presenter/guides/installing-shabad-os-presenter) +- [Configuring Live Stream Captions](https://docs.shabados.com/presenter/guides/configuring-live-stream-captions) +- [Importing an overlay theme](https://docs.shabados.com/presenter/guides/importing-an-overlay-theme) ### Features @@ -60,76 +41,16 @@ See: ## Community -Get updates on Shabad OS and chat with the project maintainers and community members. - -- [![Instagram][instagram-image]][instagram-url] Follow Shabad OS on Instagram -- [![Twitter][twitter-image]][twitter-url] Follow Shabad OS on Twitter. -- [![Chat][chat-image]][chat-url] Join the official Slack channel. - -## Contributing - -There are multiple ways to contribute whether you are a user or developer. For example: - -- [Submit bugs and feature requests][new-issue-url]. -- Review documentation and make pull requests for anything from typos to new content. -- Give feedback on the onboarding process to make it easier for others to join the project. - -If you're interested in contributing to the source code of Theme Tool, then please see [Contributing Guidelines](./CONTRIBUTING.md). - -## People +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. -The original author and current lead maintainer is Saihajpreet Singh ([@saihaj](https://github.com/saihaj)). +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/). -"Thank you!" to [all the volunteers][contributor-url] who've contributed to Theme Tool. +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/). -## Feedback +If you have a concern that doesn't warrant opening a GitHub issue, please reach out to us: -- Ask questions and get help in our community chat via [Slack][chat-url] -- [Upvote popular feature requests][upvote-tracker-url] using the thumbs-up/+1 reaction on the first post of a feature request -- Follow [@shabad_os on Instagram](instagram-url) and [@shabad_os on Twitter](twitter-url) and let us know what you think! +Saihajpreet Singh, Author, Maintainer: [@saihaj](https://github.com/saihaj) -## Related Projects - -Projects in the Shabad OS ecosystem of free and open source software include: - -- [Database](https://github.com/shabados/database) -- [Viewer](https://github.com/shabados/viewer) -- [Presenter](https://github.com/shabados/presenter) -- [Mobile](https://github.com/shabados/mobile) -- [Gurmukhi Utils](https://github.com/shabados/gurmukhi-utils) - -## Code of Conduct - -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. - -> 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. -> -> We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community. -> -> [The Contributor Covenant][contributor-covenant-url] - -## License - -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). - -> 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. -> -> 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. -> -> You should have received a copy of the GNU General Public License along with this program. If not, see . +## Contributing -[release-image]: https://img.shields.io/github/workflow/status/shabados/theme-tool/Build%20and%20Deploy/master.svg?label=release -[release-url]: https://github.com/shabados/theme-tool/actions?query=workflow%3A%22Build+and+Deploy%22+branch%3Amaster -[next-image]: https://img.shields.io/github/workflow/status/shabados/theme-tool/Build%20and%20Deploy/dev.svg?label=next%20release -[next-url]: https://github.com/shabados/theme-tool/actions?query=workflow%3A%22Build+and+Deploy%22+branch%3Adev -[website-url]: https://shabados.com -[instagram-image]: https://img.shields.io/badge/Instagram-%40shabad__os-C13584.svg?logo=instagram&logoColor=white -[instagram-url]: https://www.instagram.com/shabad_os/ -[twitter-image]: https://img.shields.io/badge/Twitter-%40shabad__os-1DA1F2.svg?logo=twitter&logoColor=white -[twitter-url]: https://www.twitter.com/shabad_os/ -[chat-image]: https://img.shields.io/badge/Chat-Public%20Slack%20Channels-1264a3.svg?logo=slack -[chat-url]: https://chat.shabados.com -[new-issue-url]: https://github.com/shabados/theme-tool/issues/new/choose -[contributor-url]: https://github.com/shabados/theme-tool/graphs/contributors -[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 -[contributor-covenant-url]: https://www.contributor-covenant.org/version/2/0/code_of_conduct/ +Please see [CONTRIBUTING.md](/CONTRIBUTING.md).