From d34e78fbaf7b520120652f5b4cf0b868ed293352 Mon Sep 17 00:00:00 2001 From: hiro98 Date: Sun, 5 Jul 2020 20:12:03 +0200 Subject: [PATCH] add readme --- README.md | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..91b699c --- /dev/null +++ b/README.md @@ -0,0 +1,33 @@ +# stream - the Simple Transmission Emitter And Monitor + +A simple daemon and web interface to manage `ffmpeg` processes to +transcode `rtsp` to `rtmp` on affordable hardware (i.e. a raspberry +pi). This is the successor to the `doccam-*` projects (where * = +[pi](https://gitlab.com/vale9811/doccam-pi) | +[server](https://gitlab.com/vale9811/doccam-server)) | +[server-docker](https://gitlab.com/vale9811/doccam-server-docker)). + +The aim is to further simplify the software and rely largely on well +established utilities for monitoring and tunneling: `systemd` and +`wireguard`. + +## Contributing + +This is an early stage effort and not intended for use yet. If you'd +like to hack on the project, feel free to open an issue or pull +request. + +## License + +Copyright © 2020 Valentin Boettcher + +This program and the accompanying materials are made available under the +terms of the Eclipse Public License 2.0 which is available at +http://www.eclipse.org/legal/epl-2.0. + +This Source Code may also be made available under the following Secondary +Licenses when the conditions for such availability set forth in the Eclipse +Public License, v. 2.0 are satisfied: GNU General Public License as published by +the Free Software Foundation, either version 2 of the License, or (at your +option) any later version, with the GNU Classpath Exception which is available +at https://www.gnu.org/software/classpath/license.html.