Skip to content

Commit 91d1075

Browse files
chewittFlole998
authored andcommitted
repo: cleanup README.md
1 parent aadcc3a commit 91d1075

1 file changed

Lines changed: 34 additions & 36 deletions

File tree

‎README.md‎

Lines changed: 34 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,4 @@
1-
![TVHeadend Logo](https://github.com/tvheadend/tvheadend/raw/master/src/webui/static/img/satip-icon120.png)
2-
Tvheadend
3-
========================================
4-
(c) 2006 - 2024 Tvheadend Project (https://tvheadend.org)
5-
6-
Status
7-
------
1+
<div align="center">
82

93
[![Build Status](https://github.com/tvheadend/tvheadend/actions/workflows/build-cloudsmith.yml/badge.svg?branch=master)](https://github.com/tvheadend/tvheadend/actions/workflows/build-cloudsmith.yml)
104
[![Coverity Scan](https://scan.coverity.com/projects/2114/badge.svg)](https://scan.coverity.com/projects/2114)
@@ -16,74 +10,78 @@ Status
1610

1711
[![Hosted By: Cloudsmith](https://img.shields.io/badge/Packages%20hosted%20by-cloudsmith-blue?logo=cloudsmith&style=flat-square)](https://cloudsmith.io/~tvheadend/repos/tvheadend/packages/)
1812

13+
</div>
1914

15+
Tvheadend
16+
=========
2017

21-
What it is
22-
----------
18+
Tvheadend is the leading TV streaming server and Digital Video Recorder for Linux.
2319

2420
![tvheadend front page](https://github.com/tvheadend/tvheadend/raw/master/src/webui/static/img/epg.png)
2521

26-
Tvheadend is a TV streaming server and digital video recorder.
27-
2822
It supports the following inputs:
2923

24+
* ATSC
3025
* DVB-C(2)
31-
* DVB-T(2)
3226
* DVB-S(2)
33-
* ATSC
34-
* SAT>IP
27+
* DVB-T(2)
3528
* HDHomeRun
3629
* IPTV
3730
* UDP
3831
* HTTP
32+
* SAT>IP
33+
* Unix Pipe
3934

4035
It supports the following outputs:
4136

37+
* HTSP (native protocol)
4238
* HTTP
43-
* HTSP (own protocol)
4439
* SAT>IP
4540

46-
Running in docker
47-
-----------------
48-
Running in docker can be as simple as
41+
Documentation
42+
-------------
4943

50-
$ docker run --rm ghcr.io/tvheadend/tvheadend:latest
44+
Tvheadend documentation can be found here: [https://docs.tvheadend.org](https://docs.tvheadend.org).
45+
46+
Support
47+
-------
5148

52-
See [README.Docker.md](README.Docker.md) in this repository for more details.
49+
Please triage issues and ask questions in the forum: [https://tvheadend.org](https://tvheadend.org) or use the `#hts` IRC channel on Libera.Chat to speak with project staff: [https://web.libera.chat/#hts](https://web.libera.chat/#hts).
5350

54-
How to build for Linux
55-
----------------------
51+
Please report triaged bugs via GitHub Issues.
52+
53+
Building for Linux
54+
------------------
5655

5756
First you need to configure:
5857

5958
$ ./configure
6059

61-
If any dependencies are missing the configure script will complain or attempt
60+
If build dependencies are missing the configure script will complain or attempt
6261
to disable optional features.
6362

64-
Build the binary:
63+
To build the binary:
6564

6665
$ make
6766

68-
After build, the binary resides in `build.linux` directory.
67+
After compiling the Tvheadend binary is in the `build.linux` directory.
6968

70-
Thus, to start it, just type:
69+
To run the Tvheadend binary:
7170

7271
$ ./build.linux/tvheadend
7372

7473
Settings are stored in `$HOME/.hts/tvheadend`.
7574

76-
How to build for OS X
77-
---------------------
75+
Running on Linux
76+
----------------
77+
78+
Instructions for popular distributions are in our public [documentation](https://docs.tvheadend.org/documentation/installation/linux).
7879

79-
Same build procedure applies to OS X.
80-
After build, the binary resides in `build.darwin` directory.
80+
Running in Docker
81+
-----------------
8182

82-
Only network sources (IPTV, SAT>IP) are supported on OS X.
83-
There is no support for DVB USB sticks and PCI cards.
84-
Transcoding is currently not supported.
83+
Running in Docker can be as simple as:
8584

86-
Packages
87-
--------
85+
$ docker run --rm ghcr.io/tvheadend/tvheadend:latest
8886

89-
Install instructions for various distributions can be found in our [documentation](https://docs.tvheadend.org/documentation/installation/linux).
87+
See [README.Docker.md](README.Docker.md) for more details.

0 commit comments

Comments
 (0)