Skip to content

Commit 73dee16

Browse files
committed
chore: README
1 parent 1e97c25 commit 73dee16

2 files changed

Lines changed: 23 additions & 2 deletions

File tree

README.md

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,26 @@
22

33
<img src="docs/logo/ograf-logo-colour.svg" width="300"/>
44

5+
_This tool is running at [https://ograf-devtool.superfly.tv](https://ograf-devtool.superfly.tv)_
6+
57
This is a tool to help with developing <b>[OGraf](https://ograf.ebu.io/) Graphics</b>.
68

7-
The tool is running at [https://ograf-devtool.superfly.tv/](https://ograf-devtool.superfly.tv/)
9+
## Main features
10+
11+
- Loads and displays OGraf Graphics directly from your local hard drive.
12+
- Runs various checks on the OGraf Graphics to find common mistakes that makes them non-compliant with the OGraf specification.
13+
- Control GUI for testing RealTime OGraf Graphics.
14+
- Control GUI for testing Non-RealTime OGraf Graphics.
15+
16+
![Screenshot of the GUI](/docs/screenshot0.jpg?raw=true "Screenshot")
17+
18+
## Having a problem?
19+
20+
If the problem is related to the DevTool itself, please open an [issue here](https://github.com/SuperFlyTV/ograf-devtool/issues) or [contribute a fix](https://github.com/SuperFlyTV/ograf-devtool/pulls) yourself!
821

9-
## For Developers
22+
If the problem is related to the OGraf Specification, please [open an issue on the OGraf repository](https://github.com/ebu/ograf/issues).
23+
24+
## For Developers of the OGraf DevTool
1025

1126
```bash
1227

@@ -22,3 +37,9 @@ npm run start
2237
# Start the client in dev-mode and serve it locally:
2338
npm run dev
2439
```
40+
41+
### Deployment
42+
43+
Simply push to the `main` branch. A Github Action will publish a Docker Image and pull it onto the deployment server.
44+
45+
_(SuperFly-internal notes are [here](https://github.com/SuperFlyTV/internal-scripts/tree/main/SuperFlyTV/ograf-devtool).)_

docs/screenshot0.jpg

476 KB
Loading

0 commit comments

Comments
 (0)