From c7c2555fc72c75dc17956b9249b595fcf6ea7ae6 Mon Sep 17 00:00:00 2001 From: Tore Sinding Bekkedal Date: Mon, 4 May 2020 12:36:50 +0200 Subject: [PATCH] update/flesh out README.md --- README.md | 36 ++++++++++++++++++++++++++++++++---- 1 file changed, 32 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index af4c310b..c03301fa 100644 --- a/README.md +++ b/README.md @@ -5,16 +5,44 @@ Tools and web for the Norwegian public access TV channel [Frikanalen](https://fr [GitHub page](http://github.com/Frikanalen/) | [Project mailing list](http://lists.nuug.no/mailman/listinfo/frikanalen/) -This is a repo with several different projects in it. You'll find them in [/packages](packages/): +This repository is home to all the software used by Frikanalen. The main [packages](packages/) are: -- [fkweb](packages/fkweb) - This is the website, and the API. +- [frontend](packages/frontend) - Our new frontend, under active development +- [fkweb](packages/fkweb) - A Django site that serves as our API and legacy front-end +- [playout](packages/playout) - The CasparCG controller that manages our channel - [fkupload](packages/fkupload) - Upload backend (the frontend is in fkweb) taking files from users - [fkprocess](packages/fkprocess) - The processing backend for the files -- [utils](packages/utils) - Small utilities and helpers, and things we find no other place for +- [utils](packages/utils) - Small utilities, microservices and helpers, and things we find no other place for + - [atem-control-service](packages/utils/atem-control-service) - Microservice to control our production switcher + - [nagios-check-video-stream](packages/utils/nagios-check-video-stream) - Legacy checker for video stream (Prometheus rewrite in progress) + - [obe-service](packages/utils/obe-service) - systemd wrapper for Open Broadcast Encoder + - [on-air-graphics](packages/utils/on-air-graphics) - clock, program schedule, etc for filling gaps between programmes + - [prom-check-video-stream](packages/utils/prom-check-video-stream) - New checker for video stream (incomplete) + - [stream-multicast](packages/utils/stream-multicast) - systemd wrapper for multicast stream + - [test-videos-generator](packages/utils/test-videos-generator) - generate test videos for local development + - [transcode-obe-to-webm-stream](packages/utils/transcode-obe-to-webm-stream) - systemd wrapper for transcoding to WebM for legacy frontend Of note is also [our infrastructure Ansible setup](infra/). -Some folders have a basic README-file explaining what it is. +Some folders have a basic README file. + +## Getting in touch / involved + +Frikanalen is actively seeking volunteers who want to be part of building our unique service. + +If you're curious about the project, please get in touch on our IRC channel #frikanalen on Freenode, or #dev:frikanalen.no on Matrix. + +Tech lead for the project is [Tore Sinding Bekkedal](https://github.com/toresbe/) and he can be reached [by mail](mailto:toresbe@gmail.com) as well. + +## Current development focus + +- We are migrating to Kubernetes +- We are modernizing our playout code + - Instrumentalization, monitoring/alerting + - Intelligently filling idle air time [with graphics](packages/utils/on-air-graphics) +- We are writing a new front-end + - Migrating functionality from legacy site: Video archive, member sign-up, scheduling, ... + - The current development is only tested in Chrome and needs cross-browser testing/CSS adjustment Running all tests -----------------