Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update CONTRIBUTING.md and README.md #35

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Update CONTRIBUTING.md and README.md #35

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d08722a
Create CONTRIBUTING.md
hummelstrand Nov 22, 2023
4b74e54
Update README.md
hummelstrand Nov 22, 2023
745e621
Update README.md
hummelstrand Nov 22, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# How to Contribute to this Repository

Before contributing to this specific repository, please read the [Contribution Guidelines](https://nrkno.github.io/sofie-core/docs/for-developers/contribution-guidelines) for the Sofie project.


## Branches
This repository uses the following branches:

* **_master_** is our main branch. We consider it stable and it is used in production.
* The **_releaseXX_** branches are our in-development branches. When a release is ready, we decide to “freeze” that branch and create a new **_releaseXX+1_** branch.

We encourage you to base your contributions on the latest **releaseXX** branch, alternatively the **master** branch or a recently frozen **releaseXX** branch. The [Sofie Releases](https://nrkno.github.io/sofie-core/releases) page collects the status and timeline of the releases.
27 changes: 19 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,21 @@
# Sofie: The Modern TV News Studio Automation System (Ember+ Connection)
# Sofie Ember+ Connection

A TyepScript implementation of [Lawo's Ember+](https://github.com/Lawo/ember-plus) control protocol for Node.
This is the _Ember+ Connection_ library of the [**Sofie** TV Automation System](https://github.com/nrkno/Sofie-TV-automation/), a TypeScript implementation of [Lawo's Ember+](https://github.com/Lawo/ember-plus) control protocol for _Node.js_. It has been tested with _Lawo Ruby_, _Lawo R3lay_, and _Lawo MxGUI_.

It has been tested with Lawo Ruby, Lawo R3lay and Lawo MxGUI.
The current version is very losely based on the original library and Mr. Gilles Dufour's rewrites. It is however rewritten almost completely from scratch and bears little to no resemblance to earlier libraries.

The current version is very losely based on the original library and Mr Gilles Dufour's rewrites. It is however rewritten
almost completely from scratch and bears little to no resemblance to earlier libraries.

## Example usage
### 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)

---

## Example Usage

### Client

Expand Down Expand Up @@ -74,7 +82,7 @@ client
)
```

### Setting new value
### Setting New Value

```javascript
client = new EmberClient(LOCALHOST, PORT)
Expand All @@ -101,7 +109,7 @@ const req = await client.invoke(fn, 1, 2, 3)
console.log('result', await req.response)
```

### Basic server
### Basic Server

```javascript
const {
Expand Down Expand Up @@ -206,3 +214,6 @@ const tree = {

s.init(tree) // initiate the provider with the tree
```
---

_The NRK logo is a registered trademark of Norsk rikskringkasting AS. The license does not grant any right to use, in any way, any trademarks, service marks or logos of Norsk rikskringkasting AS._