summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorCarl Worth <cworth@cworth.org>2003-05-14 18:30:57 +0000
committerCarl Worth <cworth@cworth.org>2003-05-14 18:30:57 +0000
commitb3b306dfd91b4126812254380dc3a7ae77f33935 (patch)
tree8532d3fce5b9136bc7e8b7caef96ecab2345dfc5 /README
parent7e1f3f1798eace4f5a48079a949717da8b5a0d50 (diff)
Added toplevel functions for setting surface matrix, filter. Introduced new XrMatrix object. Fixed to properly hint scaled fonts.
Diffstat (limited to 'README')
-rw-r--r--README56
1 files changed, 37 insertions, 19 deletions
diff --git a/README b/README
index 2296a913..faeba682 100644
--- a/README
+++ b/README
@@ -1,13 +1,29 @@
-Xr - Rendering for X
+Xr - Rendering library
+
+Compiling
+---------
+See the INSTALL document for build instructions.
Description
-----------
Xr provides anti-aliased vector-based rendering for X. Paths consist
of line segments and cubic splines and can be rendered at any width
with various join and cap styles. All colors may be specified with
-optional translucence (opacity/alpha) throught the extended
+optional translucence (opacity/alpha) and combined using the extended
Porter/Duff compositing algebra as found in the X Render Extension.
+Xr exports a stateful rendering API similar in spirit to the path
+construction, text, and painting operators of PostScript, (with the
+significant addition of translucence in the imaging model). When
+complete, the API is intended to support the complete imaging model of
+PDF 1.4.
+
+Xr relies on the Xc library for backend rendering. Xc provides an
+abstract interface for rendering to multiple target types. As of this
+writing, Xc allows Xr to target X drawables as well as generic image
+buffers. Future backends such as PostScript, PDF, and perhaps OpenGL
+are currently being planned.
+
Dependencies
------------
Xr currently requires the following supporting libraries:
@@ -15,27 +31,18 @@ Xr currently requires the following supporting libraries:
Xc
Xft
fontconfig
-
-Usage
------
-Xr exports a stateful rendering API similar in spirit to the path
-construction, text, and painting operators of PostScript, (with the
-significant addition of translucence in the imaging model). The API
-was carefully designed to be easily understood with as little
-additional explanation as possible. All functions take a minimal
-number of arguments so that the number and order of arguments should
-be easy to remember without the need to continually consult reference
-documentation while developing with Xr.
+ libic
+ libpixregion
Documentation
-------------
-As mentioned above, we hope that users of Xr will be productive
-without having to consult the documentation often. Ideally, a simple
-glance at the Xr.h header file will provide enough information for the
-programmer.
+There's not much documentation yet apart from the Xr.h header
+file. We'll be correcting that shortly.
-We'll see if we've been successful in our goal, since for the moment
-the Xr.h header file is the only documentation that currently exists.
+In the meantime, the xrtest module in CVS provides a few example
+programs using Xr. These may be helpful to a programmer just beginning
+with Xr. Also, familiarity with the PostScript imaging model will
+help in understanding Xr.
History
-------
@@ -43,3 +50,14 @@ Xr was developed by Carl Worth <cworth@isi.edu> and Keith Packard
<keithp@keithp.com>. Many thanks are due to Lyle Ramshaw without whose
patient help our ignorance would be much more apparent.
+Mailing List
+------------
+If you have trouble with Xr or you have some ideas for how it could be
+improved, please feel free to send a message to xr@xwin.org.
+
+Xr is still under active development and all discussion happens on
+that list. So if you want to lurk or, (even better), take part in the
+development, take a look. Subscription information and archives are
+available:
+
+ http://xwin.org/cgi-bin/mailman/listinfo/xr