Browse Source

Add README file.

Georgi Chorbadzhiyski 8 years ago
parent
commit
5627d6d019
1 changed files with 51 additions and 0 deletions
  1. 51 0
      README

+ 51 - 0
README View File

@@ -0,0 +1,51 @@
1
+libtsfuncs
2
+==========
3
+Collection of routines to work with mpeg PSI tables.
4
+
5
+Using it
6
+========
7
+Clone or download libtsfuncs in a directory in your source tree and
8
+look at the example Makefile bellow:
9
+
10
+---
11
+TSFUNCS_DIR = libtsfuncs
12
+TSFUNCS_LIB = $(TSFUNCS_DIR)/libtsfuncs.a
13
+
14
+all: prog
15
+
16
+prog_OBJS = main.o $(TSFUNCS_LIB)
17
+
18
+$(TSFUNCS_LIB):
19
+	$(MAKE) -s -C $(TSFUNCS_DIR)
20
+
21
+prog: $(prog_OBJS)
22
+	$(CC) $(CFLAGS) $(prog_OBJS) -o prog
23
+---
24
+
25
+In every C file that you need to use it, add
26
+
27
+#include "libtsfuncs/tsfuncs.h"
28
+
29
+Documentation
30
+=============
31
+There isn't any. I'm too lazy to write proper docs. Maybe some day but
32
+until then just look at the tsfuncs.h, tsdata.h and log.h header files.
33
+
34
+Development
35
+===========
36
+The development is tracked using git. The repository is hosted at github
37
+to get it, run the following command:
38
+
39
+   git clone git://github.com/gfto/libtsfuncs.git
40
+
41
+Releases
42
+========
43
+Official releases can be downloaded from libtsfuncs home page which is
44
+
45
+   http://georgi.unixsol.org/programs/libtsfuncs/
46
+
47
+Contact
48
+=======
49
+For patches, bug reports, complaints and so on send e-mail to
50
+
51
+   Georgi Chorbadzhiyski <georgi@unixsol.org>