[tekui-devel] tekui: README: more improvements, HTML version regenerated

Timm S. Mueller tmueller at neoscientists.org
Fri May 9 14:26:21 CEST 2008


details:   http://hg.teklib.org/tekui/rev/3932a8f576a9
changeset: 476:3932a8f576a9
user:      Timm S. Mueller <tmueller at neoscientists.org>
date:      Fri May 09 09:04:45 2008 +0200
description:
README: more improvements, HTML version regenerated

diffs (truncated from 284 to 100 lines):

diff -r 9de8a2685f03 -r 3932a8f576a9 README
--- a/README	Thu May 08 20:59:17 2008 +0200
+++ b/README	Fri May 09 09:04:45 2008 +0200
@@ -35,8 +35,7 @@ Its main focus is on rapid development o
 Its main focus is on rapid development of custom-made devices and
 applications, often with a custom appearance and under
 resource-constrained conditions, such as for embedded devices with a
-display controller, or integrated into applications, browser plug-ins
-and games.
+display controller.
 
 Being mostly written in the Lua scripting language (see
 [[http://www.lua.org/]]), it is easily extensible with new user
@@ -104,15 +103,15 @@ Lua. It is planned to additionally surro
 Lua. It is planned to additionally surround the toolkit with a C
 library, for making it fully generic. In this scenario, Lua would
 continue to play its role as the toolkit's notification and
-interconnection language. Note that the programming interface is
-nowhere complete and fully stable yet, so be prepared for structural
-and API changes.
+interconnection language.
+
+Note that the programming interface is nowhere complete and fully
+stable yet, so be prepared for structural and API changes.
 
 === 2.1. Selected features ===
 
  * Automatic layouting and scalability
- * Sensitivity to fonts and the display's aspect ratio
- * Support for antialiased fonts
+ * Font-sensitivity, support for antialiased fonts
  * Allows for multi-windowed and fullscreen applications
  * Grids, tabs, canvases, scrollgroups, custom layout hooks
  * Fully incremental refresh logic, backbuffers are not required
@@ -138,20 +137,19 @@ from the Theme class.
 
 The C library is based on the TEKlib middleware project (see
 [[http://www.teklib.org/]] for details). All required modules are
-readily contained in tekUI's source code distribution, to reduce
-the hassle of getting and installing the software.
+readily contained in tekUI's source code distribution, to reduce the
+hassle of building and installing the software.
 
 The C library provides the host interface and a few
 performance-critical routines. Rendering and input handling are
-strictly isolated in the form of a '''virtual device driver''',
-which allows for easy exchangeability.
+strictly isolated in the form of a virtual device driver, which
+allows for easy exchangeability.
 
 Aside from the device driver interface, the C library provides
 OS-like facilities such as portable threads and a timer device.
-Depending on your application and its kind of deployment, it can
-be extended with more input drivers, a virtual filesystem,
-multimedia codecs etc., and be ported to any 32bit architecture,
-as it can act as a small embedded operating system if necessary.
+Depending on your application and its kind of deployment, it can be
+extended with more input drivers, a virtual filesystem, file format
+and multimedia codecs etc. and be ported to any 32bit architecture.
 
 === 2.4. Lua, C and object model ===
 
@@ -209,7 +207,7 @@ Supported build tools are {{gmake}} (com
 
 '''FreeBSD note''': You need a Lua interpreter which is linked with
 the {{-pthread}} option, as tekUI is using multithreaded code in
-shared objects, which are dynamically loaded by the interpreter.
+shared objects, which are loaded dynamically by the interpreter.
 
 === 3.3. Building ===
 
@@ -223,25 +221,25 @@ The regular build procedure is invoked w
 
 === 3.4. Installation ===
 
-Note that it is not strictly required to install tekUI globally. Once
-it is built, it can be worked with and developed further, as long as
-you stay in the top-level directory of the package. All required
-modules and classes will be found if programs are started from there,
-e.g.:
+Note that a system-wide installation of tekUI is not strictly
+necessary. Once it is built, it can be worked with and developed
+against, as long as you stay in the top-level directory of the
+package. All required modules and classes will be found if programs
+are started from there, e.g.:
 
   # bin/demo.lua
 
 If staying in a certain directory is not desirable, tekUI must be
-installed system-wide. By default, the installation paths are
+installed globally. By default, the installation paths are
 {{/usr/local/lib/lua/5.1/tek}} and {{/usr/local/share/lua/5.1/tek}}.
+
 It is not unlikely that this is different from what is common for
 your operating system, distribution or development needs, so be sure
-to adjust these paths in the {{config}} file. The installation is
-conveniently invoked with
+to have adjusted these paths in the {{config}} file. The installation
+is conveniently invoked with
 


More information about the tekui-devel mailing list