https://github.com/build-canaries/cctray
CCTray Spec
https://github.com/build-canaries/cctray
cctray documentation official spec
Last synced: 3 months ago
JSON representation
CCTray Spec
- Host: GitHub
- URL: https://github.com/build-canaries/cctray
- Owner: build-canaries
- License: other
- Created: 2019-03-05T12:04:02.000Z (about 7 years ago)
- Default Branch: main
- Last Pushed: 2025-07-22T12:16:50.000Z (10 months ago)
- Last Synced: 2025-07-22T14:21:31.007Z (10 months ago)
- Topics: cctray, documentation, official, spec
- Language: HTML
- Homepage: https://cctray.org/
- Size: 203 KB
- Stars: 18
- Watchers: 5
- Forks: 11
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# CCTray Spec
[cctray.org](https://cctray.org/)
## Implementing
If you are building a server or client for the CCTray format, you can read about the spec at
[cctray.org](https://cctray.org/).
## Contributing
If you have created a server or client that understands the CCTray format please submit a PR to this repo to get it
added to the site.
### Prerequisites
You'll need the follow tools installed to run locally:
* [Ruby](https://www.ruby-lang.org/)
#### Ruby
[chruby](https://github.com/postmodern/chruby) and [ruby-install](https://github.com/postmodern/ruby-install) are
supported and can be used to install the correct version of Ruby.
If you choose to install Ruby manually the correct version can be found in the `.ruby-version` file.
### Developing locally
The following major technologies and libraries are used.
- [GitHub Pages with Jekyll](https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll)
#### Running
You can run the `develop.sh` script to automatically watch all the sources and recompile, see the script for more
information.
```
./develop.sh
```
#### Verifying changes
Given the simple static nature of the site, no automated tests or CI have been set up. Therefore, you will need to
manually check and verify all changes.
### Tips
Most people will either be updating the `pages/clients.md` or `pages/servers.md` files to add new clients or servers
respectively.
Some things to keep in mind when updating these pages.
- Keep them in alphabetical order
- Update the `updated` attribute at the top of the file
- Follow the examples already in the file