[hackers] [svkbd] Fixing README and the build environment. || Christoph Lohmann

From: <hg_AT_suckless.org>
Date: Sun, 30 Oct 2011 13:04:15 +0100 (CET)

changeset: 53:32245a9dbd30
tag: tip
user: Christoph Lohmann <20h_AT_r-36.net>
date: Sun Oct 30 13:02:42 2011 +0100
files: Makefile README README.md
description:
Fixing README and the build environment.


diff -r 458c7db794fd -r 32245a9dbd30 Makefile
--- a/Makefile Wed Oct 19 10:49:23 2011 +0200
+++ b/Makefile Sun Oct 30 13:02:42 2011 +0100
_AT_@ -4,7 +4,6 @@
 include config.mk
 
 SRC = svkbd.c
-LAYOUTS = en de arrows
 
 all: options svkbd-en
 
_AT_@ -13,7 +12,6 @@
         _AT_echo "CFLAGS = ${CFLAGS}"
         _AT_echo "LDFLAGS = ${LDFLAGS}"
         _AT_echo "CC = ${CC}"
- _AT_echo "LAYOUT = ${LAYOUT}"
 
 config.h: config.mk
         _AT_echo creating $@ from config.def.h
_AT_@ -27,9 +25,12 @@
 
 clean:
         _AT_echo cleaning
- _AT_for i in ${LAYOUTS}; \
+ _AT_for i in svkbd-*; \
         do \
- rm -f svkbd-$$i 2> /dev/null; \
+ if [ -x $$i ]; \
+ then \
+ rm -f $$i 2> /dev/null; \
+ fi \
         done; true
         _AT_rm -f ${OBJ} svkbd-${VERSION}.tar.gz 2> /dev/null; true
 
_AT_@ -38,9 +39,9 @@
         _AT_mkdir -p svkbd-${VERSION}
         _AT_cp LICENSE Makefile README config.def.h config.mk \
                 ${SRC} svkbd-${VERSION}
- _AT_for i in ${LAYOUTS}; \
+ _AT_for i in layout.*.h; \
         do \
- cp layout.$$i.h svkbd-${VERSION}; \
+ cp $$i svkbd-${VERSION}; \
         done
         _AT_tar -cf svkbd-${VERSION}.tar svkbd-${VERSION}
         _AT_gzip svkbd-${VERSION}.tar
_AT_@ -49,13 +50,13 @@
 install: all
         _AT_echo installing executable files to ${DESTDIR}${PREFIX}/bin
         _AT_mkdir -p ${DESTDIR}${PREFIX}/bin
- _AT_for i in ${LAYOUTS}; \
+ _AT_for i in svkbd-*; \
         do \
- if [ -e svkbd-$$i ]; \
+ if [ -x $$i ]; \
                 then \
- echo CP svkbd-$$i; \
- cp svkbd-$$i ${DESTDIR}${PREFIX}/bin; \
- chmod 755 ${DESTDIR}${PREFIX}/bin/svkbd-$$i; \
+ echo CP $$i; \
+ cp $$i ${DESTDIR}${PREFIX}/bin; \
+ chmod 755 ${DESTDIR}${PREFIX}/bin/$$i; \
                 fi \
         done
 # _AT_echo installing manual page to ${DESTDIR}${MANPREFIX}/man1
diff -r 458c7db794fd -r 32245a9dbd30 README
--- a/README Wed Oct 19 10:49:23 2011 +0200
+++ /dev/null Thu Jan 01 00:00:00 1970 +0000
_AT_@ -1,29 +0,0 @@
-svkbd - simple virtual keyboard
-===============================
-svkbd is a small X client application usefull for emulating a keyboard
-on the screen.
-
-
-Requirements
-------------
-In order to build svkbd you need the Xlib and XTest header files.
-
-
-Installation
-------------
-Edit config.mk to match your local setup (svkbd is installed into
-the /usr/local namespace by default).
-
-Afterwards enter make svkbd.<LAYOUT> to compile svkbd, where <LAYOUT> can
-be one of de, en, arrows. "make" defaults to svkbd.en, which is copied to
-svkbd
-
-Configuration
--------------
-The configuration of svkbd is done by creating a custom config.h
-and (re)compiling the source code.
-
-You can define your own keyboard layouts by creating layout.<IDENTIFIER>.h.
-Afterwards, build your customized version by executing
-
- make svkbd.<IDENTIFIER>
diff -r 458c7db794fd -r 32245a9dbd30 README.md
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/README.md Sun Oct 30 13:02:42 2011 +0100
_AT_@ -0,0 +1,44 @@
+SVKBD
+=====
+This is a simple virtual keyboard, intended to be used in environments,
+where no keyboard is available.
+
+Installation
+------------
+
+ % make
+ % make install
+
+This will create by default `svkbd-en`, which is svkbd using an English
+keyboard layout. You can create svkbd for additional layouts by doing:
+
+ % make svkbd-$layout
+
+This will take the file `layout.$layout.h` and create `svkbd-$layout`.
+`make install` will then pick up the new file and install it accordingly.
+
+Usage
+-----
+
+ % svkbd-en
+
+This will open svkbd at the bottom of the screen, showing the default
+English layout.
+
+ % svkbd-en -d
+
+This tells svkbd-en to announce itself being a dock window, which then
+is managed differently between different window managers. If using dwm
+and the dock patch, then this will make svkbd being managed by dwm and
+some space of the screen being reserved for it.
+
+ % svkbd-en -g 400x200+1+1
+
+This will start svkbd-en with a size of 400x200 and at the upper left
+window corner.
+
+Repository
+----------
+
+ hg clone http://hg.suckless.org/svkbd
+
Received on Sun Oct 30 2011 - 13:04:15 CET

This archive was generated by hypermail 2.3.0 : Sun Oct 30 2011 - 13:12:05 CET