tAdd README to the project - libwm - X windows manipulation library
HTML git clone git://z3bra.org/libwm
DIR Log
DIR Files
DIR Refs
DIR README
DIR LICENSE
---
DIR commit 599df0a7d465932cd9120c18ec483644eab4e8dd
DIR parent 0d6908dc2e053a32979b693284727e3c6fe72922
HTML Author: z3bra <willyatmailoodotorg>
Date: Sat, 14 Nov 2015 14:58:31 +0100
Add README to the project
Diffstat:
A README | 42 +++++++++++++++++++++++++++++++
1 file changed, 42 insertions(+), 0 deletions(-)
---
DIR diff --git a/README b/README
t@@ -0,0 +1,42 @@
+# libwm
+
+A small library for X window manipulation
+
+## documentation
+
+Here is the full list of all the function you can use from `libwm`:
+
+ init_xcb();
+ kill_xcb();
+ is_alive(wid);
+ is_ignored(wid);
+ is_listable(wid, mask);
+ is_mapped(wid);
+ get_screen();
+ get_windows(wid, **list);
+ get_attribute(wid, attr);
+ get_cursor(mode, wid, *x, *y);
+ set_border(width, color, wid);
+ set_focus(wid);
+ set_cursor(x, y, mode);
+ teleport(wid, w, h, x, y);
+ move(wid, mode, x, y);
+ resize(wid, mode, w, h);
+ restack(wid, mode);
+
+Their usage is specified in the `wm.h` header file, as it is quite small for
+now.
+
+## installation
+
+`libwm` provides two files: libwm.a and wm.h.
+You can build/install them as follow:
+
+ $ make
+ # make install
+
+The makefile supports 2 macros: DESTDIR and PREFIX.
+
+Then to link your program against it, compile it as follow:
+
+ cc pgm.c -lwm -o pgm