diff --git a/.github/ISSUE_TEMPLATE/BUG_REPORT.md b/.github/ISSUE_TEMPLATE/BUG_REPORT.md new file mode 100644 index 0000000..56355ff --- /dev/null +++ b/.github/ISSUE_TEMPLATE/BUG_REPORT.md @@ -0,0 +1,38 @@ +--- +name: Bug Report +description: Use this if you've found a bug +title: "Bug Report: [Short description of the bug]" +labels: 🐛bug +assignees: '' + +--- + + + +## About Me + + +## Observed Behavior + + +## Expected Behavior + + +## Version + + +## Severity / Impact + + + diff --git a/.github/ISSUE_TEMPLATE/OTHER.md b/.github/ISSUE_TEMPLATE/OTHER.md new file mode 100644 index 0000000..9b597cd --- /dev/null +++ b/.github/ISSUE_TEMPLATE/OTHER.md @@ -0,0 +1,22 @@ +--- +name: Other Issue +description: Use this for other issues +title: "Other: [Short description of the issue]" +labels: "Other" +assignees: '' + +--- + + + +## About Me + + +## Issue + diff --git a/.github/ISSUE_TEMPLATE/QUESTION.md b/.github/ISSUE_TEMPLATE/QUESTION.md new file mode 100644 index 0000000..39d6f48 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/QUESTION.md @@ -0,0 +1,22 @@ +--- +name: Question +description: Use this if you have a question to the Sofie team +title: "Question: [Short summary of the question]" +labels: ❓ Question +assignees: '' + +--- + + + +## About Me + + +## My Question + diff --git a/.github/ISSUE_TEMPLATE/RFC.md b/.github/ISSUE_TEMPLATE/RFC.md new file mode 100644 index 0000000..4cc485c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/RFC.md @@ -0,0 +1,46 @@ +--- +name: Request for Comments +description: Use this to initiate a discussion about a new feature or a larger change +title: "RFC: [Short description of the feature/change]" +labels: RFC, Contribution +assignees: '' + +--- + + + +## About Me + + +## Background + + + +## Proposal + + + +## Status + + +The Sofie Team will evaluate this RFC and open up a discussion about it, usually within a week. + +- [x] RFC created +- [ ] Sofie Team has evaluated the RFC +- [ ] A workshop has been planned +- [ ] RFC has been discussed in a workshop +- [ ] A conclusion has been reached, see comments in thread. diff --git a/.github/PULL-REQUEST-TEMPLATE.md b/.github/PULL-REQUEST-TEMPLATE.md new file mode 100644 index 0000000..92803e9 --- /dev/null +++ b/.github/PULL-REQUEST-TEMPLATE.md @@ -0,0 +1,56 @@ + + +## About the Contributor + + + +## Type of Contribution + +This is a: + +Bug fix / Feature / Code improvement / Documentation improvement / Other (please specify) + + +## Current Behavior + + + +## New Behavior + + + +## Testing Instructions + + + +## Other Information + + + +## Status + + +- [ ] PR is ready to be reviewed. +- [ ] The functionality has been tested by the author. +- [ ] Relevant unit tests has been added / updated. +- [ ] Relevant documentation (code comments, [system documentation](https://nrkno.github.io/sofie-core/)) has been added / updated. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..242bfa8 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,11 @@ +# 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. + +We encourage you to base your contributions on the latest **_master_** branch of this repository. The [_Sofie Releases_](https://nrkno.github.io/sofie-core/releases) page collects the status and timeline of the _Sofie_ releases. diff --git a/LICENSE b/LICENSE index 6c7d52e..3a47b46 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2018 Norsk rikskringkasting AS +Copyright (c) 2023 Norsk rikskringkasting AS Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal @@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. \ No newline at end of file +SOFTWARE. diff --git a/README.md b/README.md index 09a5c27..e541f6d 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,16 @@ -# Sofie: The Modern TV News Studio Automation System (launcher for the CasparCG Server process) +# Sofie CasparCG Server Launcher +This is the _CasparCG Server Launcher_ application, part of the [**Sofie** TV Automation System](https://github.com/nrkno/Sofie-TV-automation/). -This is used in the [**Sofie** TV News Studio Automation System](https://github.com/nrkno/Sofie-TV-automation/). -> Simple launcher for CasparCG +## 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) -### Features +--- + +## Features * Presents log in a more readable format with lines coloured by severity * Builds as a single exe that can be dropped into existing casparcg folder * Allows for easy stopping and restarting of both casparcg and media-scanner @@ -17,7 +23,8 @@ This is used in the [**Sofie** TV News Studio Automation System](https://github. See the [changelog](CHANGELOG.md) for more information -### Screenshots + +## Screenshots ![](doc/status.png) @@ -25,7 +32,7 @@ This is used in the [**Sofie** TV News Studio Automation System](https://github. ![](doc/settings.png) -### Build Setup +## Build Setup ``` bash # install dependencies @@ -42,6 +49,9 @@ yarn run lint ``` +This project was generated with [electron-vue](https://github.com/SimulatedGREG/electron-vue)@[7c4e3e9](https://github.com/SimulatedGREG/electron-vue/tree/7c4e3e90a772bd4c27d2dd4790f61f09bae0fcef) using [vue-cli](https://github.com/vuejs/vue-cli). Documentation about the original structure can be found [here](https://simulatedgreg.gitbooks.io/electron-vue/content/index.html). + --- -This project was generated with [electron-vue](https://github.com/SimulatedGREG/electron-vue)@[7c4e3e9](https://github.com/SimulatedGREG/electron-vue/tree/7c4e3e90a772bd4c27d2dd4790f61f09bae0fcef) using [vue-cli](https://github.com/vuejs/vue-cli). Documentation about the original structure can be found [here](https://simulatedgreg.gitbooks.io/electron-vue/content/index.html). +_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._ +