From 4a169d2a750048a34a23495ffaceb59775e8e9cc Mon Sep 17 00:00:00 2001 From: Jonas Hummelstrand Date: Thu, 7 Dec 2023 11:36:21 +0100 Subject: [PATCH] Update README.md --- README.md | 29 ++++++++++++++++++++--------- 1 file changed, 20 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 2bf325b..2f21645 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,26 @@ -# Sofie: The Modern TV News Studio Automation System (Prompter Editor) +# Sofie Prompter Editor -_Note: This is a mono-repo._ +This is the _Sofie Prompter Editor_ application of the [_**Sofie** TV Automation System_](https://github.com/nrkno/Sofie-TV-automation/), allowing WYSIWYG editing nad realtime control of the _Sofie_ prompter. -## Introduction and Quick Start +## General Sofie System Information +* [_Sofie_ Documentation](https://nrkno.github.io/sofie-core/) +* [_Sofie_ Releases](https://nrkno.github.io/sofie-core/releases) +* [Contribution Guidelines](CONTRIBUTING.md) +* [License](LICENSE) -## File structure +--- +## Developer Information -This is a mono-repo, all packages resides in [shared/packages](shared/packages) and [apps/](apps/). +Be sure to read the [FOR DEVELOPERS](/FOR_DEVELOPERS.md) documentation. -## For Developers +Note: This monorepo uses [_Yarn_](https://yarnpkg.com) and [_Lerna_](https://github.com/lerna/lerna), so most commands can be run on the root folder (no need to `cd` into each package). -Be sure to read the [FOR DEVELOPERS](/FOR_DEVELOPERS.md) documentation. +### File Structure + +This is a monorepo, all packages resides in [shared/packages](shared/packages) and [apps/](apps/). -Note: This mono-repo uses [Yarn](https://yarnpkg.com) and [Lerna](https://github.com/lerna/lerna), so most commands can be run on the root folder (no need to cd into each package). -Initialize repo: +### Initializing ```bash # install lerna globally @@ -33,6 +39,8 @@ yarn dev Now you should be good to go. +### Before Committing Code + Before any code is committed, run these: ```bash @@ -46,3 +54,6 @@ yarn test ``` ``` +--- + +_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._