Merge pull request #12 from nrkno/hummelstrand-patch-1

Update README.md

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.

README.md

@@ -1,8 +1,16 @@
-# Sofie: The Modern TV News Studio Automation System (Input Gateway)
-An application for piping user input into the [Sofie Server Core](https://github.com/nrkno/tv-automation-server-core)
+# Sofie Input Gateway
 
-This application is a part of the [**Sofie** TV News Studio Automation System](https://github.com/nrkno/Sofie-TV-automation/).
+This is the _Input Gateway_ of the [**Sofie** TV Automation System](https://github.com/nrkno/Sofie-TV-automation/), used to pipe user input into the [Core](https://github.com/nrkno/tv-automation-server-core).
 
+## 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)
+
+---
 
 ## Usage
 ```
@@ -12,7 +20,7 @@ npm run start -host 127.0.0.1 -port 3000 -log "log.log"
 npm run start
 ```
 
-**CLI arguments:**
+**CLI Arguments:**
 
 | Argument  | Description | Environment variable |
 | ------------- | ------------- | --- |
@@ -21,17 +29,24 @@ npm run start
 | -log  | Path to output log |  CORE_LOG |
 | -id   | Device ID to use | DEVICE_ID |
 
-## Installation for dev
+## Installation for Developers
 
 * yarn
 * yarn build
 * yarn test
 
-### Dev dependencies:
+### Development Dependencies:
 
 * yarn
 	https://yarnpkg.com
 
 * jest
 	yarn global add jest
 
+---
+
+_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._
+
+
+
+