/desktop

Desktop app for searching, navigating, and presenting the Shabad OS database

Primary LanguageJavaScriptGNU General Public License v3.0GPL-3.0

128

Shabad OS for Desktop

Software for searching, navigating, and presenting the Shabad OS database.

desktop total desktop



1. Introduction

Shabad OS for Desktop is a GPL-licensed open source project with ongoing development, project management, and marketing made possible entirely by the support and dedication of unpaid volunteers.

This app can be used to display bani & gurbani in the home or at the gurdwara. A server model allows multiple devices to act as a display or a controller. The same model enables live captions to be in sync with the projector / presentation device.

Helpful features were added over years of production-ready use.

See:

1.1. Features

  • Multiple displays and controllers in sync

  • Live broadcast captioning / subtitling

  • Curated design

    • Text legibility/readability

    • Organized UI/UX functionality

  • Keyboard shortcuts

    • Search, History, Bookmarks

    • Jump to line N of shabad

    • Autoselect line based on context/position

1.2. Screenshots

readme screenshot presenter
readme screenshot controller
readme screenshot settings

1.3. Community

Get updates on Shabad OS and chat with the project maintainers and community members.

  • Instagram %40shabad  os C13584 Follow Shabad OS on Instagram.

  • Twitter %40shabad  os 1DA1F2 Follow Shabad OS on Twitter.

  • Chat Public%20Slack%20Channels 1264a3 Join the official Slack channel.

  • WhatsApp %2B1%20516%20619%206059 128C7E Direct message us on WhatsApp. Or chat with fellow Shabad OS community members in the WhatsApp group chat.

2. Contributing

There are many ways in which people can participate in Shabad OS projects. For example:

  • Submit bugs and feature requests. Help us verify whether they are resolved. See our issue tracker.

  • 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 are interested in fixing issues and contributing directly to the desktop repo, please see the document How to Contribute, which covers the following:

And "Thank you!" to all the volunteers who’ve already contributed to Shabad OS!

3. Feedback

Projects in the Shabad OS ecosystem of free and open source software which interact with or are used by the desktop repo include:

  • Database as an npm module enables access to JS libs used for querying

  • Gurmukhi Utils is used to swap input/output between ascii/unicode gurmukhi

5. Code of Conduct

Expectations for participating in Shabad OS open source communities are similar to other open source communities1. Our team and community members are committed to being welcoming, patient, and respectful. People violating this code of conduct may be banned/blocked from the community.

  • Be welcoming, for our community is made up of differing backgrounds. Including, but not limited to, race, sex, gender, culture, religion, nation, caste, education, age, politics, and mental/physical ability.

  • Be patient, for our community comprises of differing native languages. A welcoming attitude can be more constructive when communicating through someone else’s second or third language. This can also apply to programming language!

  • Be respectful, for our world-wide community includes many views and perspectives. Professional conduct rarely leads to disrespectful behavior or poor manners, so we strive to conduct ourselves professionally.

  • Be understanding, for our project may deal with subjectivities which cannot be analyzed objectively. Our goal is to use disagreements, both social and technical, as learning opportunities. Differences should be resolved as constructively as possible.

  • This code of conduct is an example. It serves to capture our goals and intents. If working on Shabad OS projects, then follow the spirit of this code as much as the literal code of conduct.

This code of conduct was influenced by Microsoft’s document, which is licensed under CC BY 4.0.

6. License

The desktop repo is under v3 of the GPL. 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.

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 www.gnu.org/licenses/.

6.1. Attribution/Credit

Though the desktop repo has no database, it is strongly related with the Shabad OS database. To learn more about the licensing of the database, please refer to the Database README.adoc