Include a description of Project Name and what it's purpose is. This does this to achieve this for you. Do not use acronyms. If applicable include screenshots and other images, links to demonstration examples, user documentation and any other applicable reference materials.
Project Name works in conjunction with Rise Vision, the digital signage management application that runs on Google Cloud.
At this time Chrome is the only browser that this project and Rise Vision supports.
example list follows, replace with actual tools used
- NPM (node package manager)
- Angularjs
- Gulp
- Bower
- Karma and Mocha for testing
provide exact details on how to setup the local environment for at least Windows, and if doable, Linux and Mac
include how to run the application locally if applicable
include and describe all dependencies
include how to run unit and e2e testing
If you encounter problems or find defects we really want to hear about them. If you could take the time to add them as issues to this Repository it would be most appreciated. When reporting issues please use the following format where applicable:
Reproduction Steps
- did this
- then that
- followed by this (screenshots / video captures always help)
Expected Results
What you expected to happen.
Actual Results
What actually happened. (screenshots / video captures always help)
All contributions are greatly appreciated and welcome! If you would first like to sound out your contribution ideas please post your thoughts to our community, otherwise submit a pull request and we will do our best to incorporate it
If this Project supports Internationalization include this section:
If you would like translate the user interface for this product to another language please complete the following:
- Download the english translation file from this repository.
- Download and install POEdit. This is software that you can use to write translations into another language.
- Open the translation file in the POEdit program and set the language for which you are writing a translation.
- In the Source text window, you will see the English word or phrase to be translated. You can provide a translation for it in the Translation window.
- When the translation is complete, save it with a .po extension and email the file to support@risevision.com. Please be sure to indicate the Widget or app the translation file is for, as well as the language that it has been translated into, and we will integrate it after the translation has been verified.
if the Project does not support Internationalization include this section and include this need in our suggested contributions
In order to support languages i18n needs to be added to this repository. Please refer to our Suggested Contributions.
- we need this
- and we need that
- we could really use this
- and if we don't already have it (see above), we could use i18n Language Support
If you have any questions or problems please don't hesitate to join our lively and responsive community at http://community.risevision.com.
If you are looking for user documentation on Rise Vision please see http://www.risevision.com/help/users/
If you would like more information on developing applications for Rise Vision please visit http://www.risevision.com/help/developers/.
Facilitator