Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
hummelstrand authored Nov 22, 2023
1 parent 6267b3e commit 56a73a0
Showing 1 changed file with 14 additions and 4 deletions.
18 changes: 14 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,30 @@
# Sofie: The Modern TV News Studio Automation System (tv-automation-quantel-browser-plugin)
# Sofie Quantel Browser Plugin
This is the _Quantel Browser_ plugin of the [**Sofie** TV Automation System](https://github.com/nrkno/Sofie-TV-automation/), a MOS-compatible Quantel and CasparCG Scanner video clip browser for the Sofie GUI.

A MOS-compatible Quantel and CasparCG Scanner video clip browser for [**Sofie** TV News Studio Automation System](https://github.com/nrkno/Sofie-TV-automation/).

### Repository-specific Info for Developers
* [Developer Info](DEVELOPER.md)
* [Contribution Guidelines](CONTRIBUTING.md)

### General Sofie System Info
* [Documentation](https://nrkno.github.io/sofie-core/)
* [Releases](https://nrkno.github.io/sofie-core/releases)

---

## Requirements

Requires a newer web browser that supports ES modules.

## How to use
## How to Use

`yarn install`

`yarn start`

This will start a web server running on port 9000 serving the contents in `/client` and serving as a proxy to the Quantel Gateway through an `/api` endpoint.

### Alternative usage
### Alternative Usage

There is no building or transpiling required, so alternatively the files in `/client` can simply be copied and served from anywhere. The internal file structure in the folder must be kept intact however.

Expand Down

0 comments on commit 56a73a0

Please sign in to comment.