Skip to content

Commit

Permalink
Merge branch 'fix/update-contribution-guidelines'
Browse files Browse the repository at this point in the history
# Conflicts:
#	README.md
  • Loading branch information
nytamin committed Sep 25, 2024
2 parents affcb9e + cb86ec6 commit d3194b3
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 5 deletions.
7 changes: 7 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# 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 **_master_** as the main branch, we require you to base your contributions on the master branch.
18 changes: 13 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,16 @@ 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.

## General Sofie System Info
### 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)
* [Contribution Guidelines](https://nrkno.github.io/sofie-core/docs/for-developers/contribution-guidelines)
* [License](LICENSE)




---

Expand Down Expand Up @@ -81,7 +86,7 @@ client
)
```

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

```javascript
client = new EmberClient(LOCALHOST, PORT)
Expand All @@ -108,7 +113,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 @@ -213,3 +218,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._

0 comments on commit d3194b3

Please sign in to comment.