Browse Source

Add README file.

Georgi Chorbadzhiyski 12 years ago
parent
commit
01de2a7f81
1 changed files with 45 additions and 0 deletions
  1. 45
    0
      README

+ 45
- 0
README View File

@@ -0,0 +1,45 @@
1
+libfuncs
2
+========
3
+You won't find anything earth shattering here. It is just a bunch
4
+of code that was used all over my projects, so I just extracted it
5
+into a self contained library suitable for static compilation and
6
+decided to release it. You'll probably find better list functions,
7
+queue functions and just about anything than what it is here, so
8
+be warned. The code works and it is used in production, but it is
9
+not pretty, documented or portable. Developed and tested in Linux
10
+environment only with very rare compilation tests under FreeBSD.
11
+
12
+Using it
13
+========
14
+Clone or download libfuncs in a directory in your source tree and
15
+look at the example Makefile bellow:
16
+
17
+---
18
+FUNCS_DIR = libfuncs
19
+FUNCS_LIB = $(FUNCS_DIR)/libfuncs.a
20
+
21
+all: prog
22
+
23
+prog_OBJS = main.o $(FUNCS_LIB)
24
+
25
+$(FUNCS_LIB):
26
+	$(MAKE) -s -C $(FUNCS_DIR)
27
+
28
+prog: $(prog_OBJS)
29
+	$(CC) $(CFLAGS) $(prog_OBJS) -o prog
30
+---
31
+
32
+In every C file that you need to use it, add
33
+
34
+#include "libfuncs/libfuncs.h"
35
+
36
+Documentation
37
+=============
38
+There isn't any. I'm too lazy to write proper docs. Maybe some day but
39
+until then just look at the header files.
40
+
41
+Contact
42
+=======
43
+Georgi Chorbadzhiyski <georgi@unixsol.org>
44
+http://georgi.unixsol.org/
45
+http://unixsol.org/

Loading…
Cancel
Save