From d08722a576540963636b8286df71f88e1c212aae Mon Sep 17 00:00:00 2001 From: Jonas Hummelstrand Date: Wed, 22 Nov 2023 16:49:11 +0100 Subject: [PATCH 1/4] Create CONTRIBUTING.md --- CONTRIBUTING.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..b893ada --- /dev/null +++ b/CONTRIBUTING.md @@ -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. From 4b74e54f76a816298374283f441d19db2c2e4454 Mon Sep 17 00:00:00 2001 From: Jonas Hummelstrand Date: Wed, 22 Nov 2023 16:54:03 +0100 Subject: [PATCH 2/4] Update README.md --- README.md | 26 ++++++++++++++++++-------- 1 file changed, 18 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index b45e1f1..f6b8df3 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,20 @@ -# 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 @@ -74,7 +81,7 @@ client ) ``` -### Setting new value +### Setting New Value ```javascript client = new EmberClient(LOCALHOST, PORT) @@ -101,7 +108,7 @@ const req = await client.invoke(fn, 1, 2, 3) console.log('result', await req.response) ``` -### Basic server +### Basic Server ```javascript const { @@ -206,3 +213,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._ From 745e62180d0570a75c228dd7ca1257db9bc77043 Mon Sep 17 00:00:00 2001 From: Jonas Hummelstrand Date: Wed, 22 Nov 2023 16:54:33 +0100 Subject: [PATCH 3/4] Update README.md --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f6b8df3..ea3290c 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Sofie Ember+ Connection -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_. +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_. 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. @@ -13,6 +13,7 @@ The current version is very losely based on the original library and Mr. Gilles * [Documentation](https://nrkno.github.io/sofie-core/) * [Releases](https://nrkno.github.io/sofie-core/releases) +--- ## Example Usage From cb86ec6b45138d36372b9518aec24a0792880a26 Mon Sep 17 00:00:00 2001 From: Johan Nyman Date: Wed, 25 Sep 2024 12:45:57 +0200 Subject: [PATCH 4/4] chore: doc --- CONTRIBUTING.md | 7 +------ 1 file changed, 1 insertion(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b893ada..64d7780 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,9 +4,4 @@ Before contributing to this specific repository, please read the [Contribution G ## 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. +This repository uses the **_master_** as the main branch, we require you to base your contributions on the master branch.