stv0g/tvheadend
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

docs: updating general docs

Browse source
This commit is contained in:
Adam Sutton 2014-05-01 22:14:43 +01:00
parent 5fbe7a7eb7
commit f91345e7f3
5 changed files with 89 additions and 43 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

42
CONTRIBUTING.md Normal file
View file

@ -0,0 +1,42 @@
# How to Contribute
The Tvheadend project welcomes all submissions from the community. Without them the project couldn't hope to thrive.
We want to ensure that the process of submitting code is as simple as possible whilst ensuring that the project has the necessary provisions to fully utilise and handle all submissions. Therefore some short guidelines are provided here for reference.
For further info, please see https://tvheadend.org/projects/tvheadend/wiki/Contributors.
## Before you start
* Make sure you have a [GitHub account](https://github.com/signup/free)
* Make sure you have a [Redmine account](https://tvheadend.org)
* Log on to the IRC channel (#hts on freenode), this is the best place to discussion development work.
* Sign the [Contributor License Agreement](https://www.clahub.com/agreements/tvheadend/tvheadend)
* Fork the repository on Github
## Making Changes
* If unsure, discuss any potential work on IRC channel to avoid duplicate work.
* Create a branch to put your changes. Use a sensible name, i.e. feature/whizzbanger, or bugfix/redmine-1234.
* It's strongly recommend you create one branch per feature/bugfix/etc..
* Make commits, try and keep commits to sensible units.
* Use sensible commit messages, prefix with subsystem, summary on first line, more detail on following lines and include reference to any related issue numbers in redmine.
````
mpegts dvb: Add foo feature to the DVB system.
Some more detail description of what has been done.
This fixes #1234.
````
* Submit a Pull Request on Github.
# Additional Resources
* [More information on contributing](https://tvheadend.org/projects/tvheadend/wiki/Contributors)
* [Bug tracker (Redmine)](https://tvheadend.org)
* [Contributor License Agreement](https://tvheadend.org/projects/tvheadend/wiki/Contributors)
* [General GitHub documentation](http://help.github.com/)
* [GitHub pull request documentation](http://help.github.com/send-pull-requests/)
* #hts IRC channel on freenode.org

36
LICENSE.md Normal file
View file

@ -0,0 +1,36 @@
Licensing
=========
The project is currently licensed using GPLv3. For full text see:
> http://www.gnu.org/licenses/gpl-3.0.txt
> [GPLv3](licenses/gpl-3.0.txt)
However we are currently in the process of seeking CLAs from all contributors. This will provide the project with the potential to re-license under any OSI approved license.
The intention is that once agreements have been received from all members we will begin to re-license the code under GPLv2.
Should you be interested in using Tvheadend and wish to use another OSI license, then please contact admin at tvheadend dot org.
Code not Covered
----------------
Code in the "vendor" directory is not covered by our license, it is 3rd party
provided code and as such is governed by individual licenses.
Code that is not yet covered by the CLAs will retain the original copyright header and GPLv3 license. However as things are migrated the headers and in-line license details will be updated.
Contributor License Agreement (CLA)
-----------------------------------
All contributors to Tvheadend are required to sign a CLA, which gives the
project a perpetual license to use the contribution as the project deems best
(within the terms of the agreement).
Further Information
-------------------
For more information regarding licensing and contributions, please see:
> https://tvheadend.org/projects/tvheadend/wiki/Contributors
> https://tvheadend.org/projects/tvheadend/wiki/CLA

41
README
View file

@ -1,41 +0,0 @@
Tvheadend v3.5
====================================
(c) 2006 - 2013 Andreas Öman, et al.
What it is
----------
Tvheadend is a TV streaming server and digital video recorder, supporting DVB-S, DVB-S2, DVB-C, DVB-T, DVB-T2, ATSC, IPTV, and Analog video (V4L) as input sources.
How to build for Linux
----------------------
First you need to configure:
$ ./configure
If any dependencies are missing the configure script will complain or attempt
to disable optional features.
Build the binary:
$ make
After build, the binary resides in `build.linux` directory.
Thus, to start it, just type:
$ ./build.linux/tvheadend
Settings are stored in `$HOME/.hts/tvheadend`.
Further information
-------------------
For more information about building, including generating packages, please visit:
> https://tvheadend.org/projects/tvheadend/wiki/Building
> https://tvheadend.org/projects/tvheadend/wiki/Packaging
> https://tvheadend.org/projects/tvheadend/wiki/Git

13
README.md
View file

@ -1,13 +1,22 @@
Tvheadend
====================================
(c) 2006 - 2013 Andreas Öman, et al.
(c) 2006 - 2014 Tvheadend Foundation CIC
What it is
----------
Tvheadend is a TV streaming server and digital video recorder, supporting DVB-S, DVB-S2, DVB-C, DVB-T, DVB-T2, ATSC, IPTV, and Analog video (V4L) as input sources.
Tvheadend is a TV streaming server and digital video recorder.
It supports the following inputs:
* DVB-C
* DVB-T(2)
* DVB-S(2)
* ATSC
* IPTV
* UDP
* HTTP
How to build for Linux
----------------------

0
LICENSE → licenses/gpl-3.0.txt
View file