Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
hummelstrand authored Dec 4, 2023
1 parent cb5450e commit c29d6d7
Showing 1 changed file with 21 additions and 10 deletions.
31 changes: 21 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,24 @@
# Sofie: The Modern TV News Studio Automation System (Package Manager)
# Sofie Package Manager

This is the "Package Manager" application of the [**Sofie** TV News Studio Automation System](https://github.com/nrkno/Sofie-TV-automation/).
This is the _Package Manager_ application of the [**Sofie** TV News Studio Automation System](https://github.com/nrkno/Sofie-TV-automation/).

_Note: This is a mono-repo._
* [_For Developers_](DEVELOPER.md)

### General Sofie System Info
* [Documentation](https://nrkno.github.io/sofie-core/)
* [Releases](https://nrkno.github.io/sofie-core/releases)
* [Contribution Guidelines](CONTRIBUTING.md)
* [License](LICENSE)

---

## Introduction and Quick Start

See the [Installing Package Manager](https://nrkno.github.io/tv-automation-server-core/docs/getting-started/installation/installing-package-manager) page of the [Sofie System Documentation](https://nrkno.github.io/tv-automation-server-core/) to learn how to get started with Package Manager in a demo environment with CasparCG.

## File structure
## File Structure

This is a mono-repo, all packages resides in [shared/packages](shared/packages) and [apps/](apps/).
This is a monorepo, all packages resides in [shared/packages](shared/packages) and [apps/](apps/).

The packages in [shared/packages](shared/packages) are helper libraries, used by the packages in [apps/](apps/).

Expand Down Expand Up @@ -38,19 +46,19 @@ The packages in [tests/](tests/) contain unit/integration tests.
| **Worker** | [shared/packages/worker](shared/packages/worker) | The Worker class is used by the Worker application |
| **Workforce** | [shared/packages/Workforce](shared/packages/Workforce) | The Workforce class is used by the Worker application |

## Notes on installation
## Notes on Installation

It has been observed a potential issue when running Package Manager as an executable on Windows:
For unknown reasons, there is a buildup of "zombie" TCP sockets over time. It is unknown if this is caused by something in Package Manager or ffmpeg/ffprobe.
As a remedy/hack, [this script](/scripts/clean-up-tcp-sockets.bat) has been useful to avoid potential longterm issues.

## For Developers

Be sure to read the [FOR DEVELOPERS](/FOR_DEVELOPERS.md) documentation.
Be sure to read the [_For Developers_](DEVELOPER.md) documentation.

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).
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).

Initialize repo:
### Initialize Repo

```bash
# install lerna globally
Expand Down Expand Up @@ -81,7 +89,7 @@ yarn lint
yarn test
```

Other useful commands:
### Other Useful Commands

```bash
# Start the single-app (contains all apps)
Expand All @@ -105,3 +113,6 @@ yarn start:workforce -- -- --port=8080
yarn start:workforce -- -- --help

```
---

_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 c29d6d7

Please sign in to comment.