Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated information files #11

Merged
merged 12 commits into from
Dec 5, 2023
38 changes: 38 additions & 0 deletions .github/ISSUE_TEMPLATE/BUG_REPORT.md
Original file line number Diff line number Diff line change
@@ -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: ''

---

<!--
Before you post, be sure to read our Contribution guidelines:
https://nrkno.github.io/sofie-core/docs/for-developers/contribution-guidelines
-->

## About Me
<!--
Tell us who / which organization you are representing, and how the Sofie team will be able to contact you.
Example: "This issue is posted on behalf of the NRK."
-->

## Observed Behavior
<!-- What happened? -->

## Expected Behavior
<!-- What did you expect to happen? -->

## Version
<!-- What version of Sofie Core / Gateways / other components are you using? -->

## Severity / Impact
<!--
How big of an issue is this? How does this limit your operations?
Examples:
* This is a blocker for us, we cannot use feature X until this is fixed.
* Not a big issue for us, but it would be nice to have this fixed.
-->


22 changes: 22 additions & 0 deletions .github/ISSUE_TEMPLATE/OTHER.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
name: Other Issue
description: Use this for other issues
title: "Other: [Short description of the issue]"
labels: "Other"
assignees: ''

---

<!--
Before you post, be sure to read our Contribution guidelines:
https://nrkno.github.io/sofie-core/docs/for-developers/contribution-guidelines
-->

## About Me
<!--
Tell us who / which organization you are representing, and how the Sofie team will be able to contact you.
Example: "This issue is posted on behalf of the NRK."
-->

## Issue
<!-- Describe the issue below -->
22 changes: 22 additions & 0 deletions .github/ISSUE_TEMPLATE/QUESTION.md
Original file line number Diff line number Diff line change
@@ -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: ''

---

<!--
Before you post, be sure to read our Contribution guidelines:
https://nrkno.github.io/sofie-core/docs/for-developers/contribution-guidelines
-->

## About Me
<!--
Tell us who / which organization you are representing, and how the Sofie team will be able to contact you.
Example: "This issue is posted on behalf of the NRK."
-->

## My Question
<!-- Write your question below. -->
46 changes: 46 additions & 0 deletions .github/ISSUE_TEMPLATE/RFC.md
Original file line number Diff line number Diff line change
@@ -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: ''

---

<!--
Before you post, be sure to read our Contribution guidelines:
https://nrkno.github.io/sofie-core/docs/for-developers/contribution-guidelines
-->

## About Me
<!--
Tell us who / which organization you are representing, and how the Sofie team will be able to contact you.
Example: "This RFC is posted on behalf of the NRK."
-->

## Background
<!--
Please write some background information here, such as:
What is your use case?
What problem are you trying to solve?
-->


## Proposal
<!--
Please describe your proposal here:
-->


## Status
<!--
Please don't touch this section, the Sofie team will update this as the RFC progresses.
-->

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.
56 changes: 56 additions & 0 deletions .github/PULL-REQUEST-TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
<!--
Before you open a PR, be sure to read our Contribution guidelines:
https://nrkno.github.io/sofie-core/docs/for-developers/contribution-guidelines
-->

## About the Contributor
<!--
Tell us who / which organization you are representing, and how the Sofie team will be able to contact you.
Example: "This pull request is posted on behalf of the NRK."
-->


## Type of Contribution

This is a:
<!-- (pick one) -->
Bug fix / Feature / Code improvement / Documentation improvement / Other (please specify)


## Current Behavior
<!--
Please describe how things worked before this PR.
If it's a bug fixe: Describe the bug (what was happening?)
-->


## New Behavior
<!--
What is the new behavior?
-->


## Testing Instructions
<!--
Please provide some instructions and other information for how to verify that the feature works.
Examples:
* "Do a Take for a part that contains an adlib, verify that the adlib plays out."
* "Open the Switchboard panel and toggle a route, verify that the route toggles in the GUI."
* "This feature also affects 'feature X', so that needs to be tested for regressions as well."
-->


## Other Information
<!-- The more information you can provide, the easier the pull request will be to merge -->


## Status
<!--
Before you open the PR, make sure the items below are done.
If they're not, please open the PR as a Draft.
-->

- [ ] 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.
11 changes: 11 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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.
4 changes: 2 additions & 2 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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.
SOFTWARE.
24 changes: 17 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -17,15 +23,16 @@ 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)

![](doc/log.png)

![](doc/settings.png)

### Build Setup
## Build Setup

``` bash
# install dependencies
Expand All @@ -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._