1. News
2. Description
3. License
4. Custom Bundles
5. Templates
6. Guidelines
7. Optional extensions
8. Links

Keep track of changes in the os2display project: News.md.

os2display is a system for creating and delivering content to screens.

It consists of the following parts:

• admin: the administration website (Symfony / AngularJS)
• screen: the client that should run on the screen to display the content created in admin (AngularJS)
• middleware: the connection between admin and screen. The content is pushed from the admin into the middleware that pushes the content to the relevant screens through websockets (node.js).
• search-node: the search engine used by admin. See https://github.com/search-node/search_node (node.js).
• docs: the documentation for the project.
• vagrant: a vagrant development setup. See https://www.vagrantup.com/.

See License.

See custom-bundles-guidelines.md for instructions on making custom bundles.

See template-guidelines.md for details concerning templates.

Guidelines for developing for os2display

• Code of Conduct
• Code standards
• GIT guidelines
• CSS guidelines
• Javascript guidelines
• Template guidelines

A number of extensions are available for OS2display:

• https://github.com/os2display/exchange-bundle
• https://github.com/os2display/template-extension-bundle
• https://github.com/os2display/horizon-template-bundle (requires https://github.com/os2display/template-extension-bundle)
• https://github.com/os2display/vimeo-bundle
• https://github.com/os2display/youtube-bundle

• See CHANGELOG.md for a list of changes to docs. Each part of the project has its own CHANGELOG.
• See installation guide for instructions on how to install os2display.
• See Release process.md for how releases are made.
• See upgrade.md for instructions on how to upgrade between versions.