Browse Source

Add more info in the README file.

Georgi Chorbadzhiyski 10 years ago
parent
commit
bc2009024b
1 changed files with 49 additions and 3 deletions
  1. 49
    3
      README

+ 49
- 3
README View File

@@ -1,7 +1,53 @@
1 1
 tomcast
2 2
 =======
3
+tomcast reads mpeg transport streams over http or udp (multicast or
4
+unicast) and outputs them to chosen multicast group. Basically a simple
5
+http2multicast daemon designed to work 24/7.
3 6
 
4
-tomcast reads mpeg transport streams over http or udp (multicast or unicast)
5
-and outputs them to chosen multicast group. Basically a simple http2multicast
6
-daemon designed to work 24/7.
7
+License
8
+=======
9
+tsdecrypt is released under GNU GPL v2.
7 10
 
11
+Development
12
+===========
13
+The development is done using git. tomcast repository is hosted
14
+at http://github.com/gfto/tomcast
15
+
16
+To clone the repository issue the following commands:
17
+
18
+   git clone git://github.com/gfto/tomcast.git
19
+   cd tomcast
20
+   git submodule init
21
+   git submodule update
22
+   make
23
+
24
+The code is developed and tested under modern Linux. It is also
25
+compiled from time to time under OS X but is not tested there.
26
+
27
+To see all Makefile targets run 'make help'.
28
+
29
+Updating the code
30
+=================
31
+To update cloned tomcast, go to the directory where the repository
32
+is cloned and run the following commands:
33
+
34
+   git fetch origin
35
+   git merge origin/master
36
+   git submodule update
37
+   make clean all
38
+
39
+tomcast's master branch should always be useful so it is safe to
40
+use it instead of official release. The master branch will always
41
+be better than any released version.
42
+
43
+Releases
44
+========
45
+Official releases can be downloaded from tomcast home page which is
46
+
47
+   http://georgi.unixsol.org/programs/tomcast/
48
+
49
+Contact
50
+=======
51
+For patches, bug reports, complaints and so on send e-mail to
52
+
53
+   Georgi Chorbadzhiyski <georgi@unixsol.org>

Loading…
Cancel
Save