summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorCarl Worth <cworth@cworth.org>2005-08-23 19:31:10 +0000
committerCarl Worth <cworth@cworth.org>2005-08-23 19:31:10 +0000
commit0b063224a6d72ea025720060abf0781d4df81757 (patch)
tree6aad9b417370b8f4046cfca678f44f283e3a152c /README
parent83aae920630ec9be77fc80cb544c6272859f4460 (diff)
Big update in preparation for 1.0.
Diffstat (limited to 'README')
-rw-r--r--README149
1 files changed, 106 insertions, 43 deletions
diff --git a/README b/README
index 5649c4bb..aa939f65 100644
--- a/README
+++ b/README
@@ -1,60 +1,123 @@
Cairo - Multi-platform 2D graphics library
http://cairographics.org
-Compiling
----------
-See the INSTALL document for build instructions.
+What is cairo
+=============
+Cairo is a 2D graphics library with support for multiple output
+devices. Currently supported output targets include the X Window
+System, OpenGL, and win32 as well as image buffers and PostScript and
+PDF files.
+
+Cairo is designed to produce consistent output on all output media
+while taking advantage of display hardware acceleration when available
+(eg. through the X Render Extension).
+
+The cairo API provides operations similar to the drawing operators of
+PostScript and PDF. Operations in cairo including stroking and filling
+cubic Bézier splines, transforming and compositing translucent images,
+and antialiased text rendering. All drawing operations can be scaled,
+rotated, or transformed through any other affine transformation.
+
+Cairo has been designed to let you draw anything you might want to
+have in a modern 2D graphical user interface. At the same time, the
+cairo API has been designed to be as easy to learn and fun to use as
+possible. If you're not having fun while programming with cairo, then
+we have failed somewhere---let us know and we'll try to fix it next
+time around.
+
+Cairo is free software and is available to be redistributed and/or
+modified under the terms of either the GNU Lesser General Public
+License (LGPL) version 2.1 or the Mozilla Public License (MPL) version
+1.1.
+
+Where to get more information about cairo
+=========================================
+The primary source of information about cairo is:
+
+ http://cairographics.org
-Description
------------
-Cairo is a vector graphics library with cross-device output
-support. Currently supported output targets include the X Window
-System and in-memory image buffers. PostScript and PDF file output is
-planned. Cairo is designed to produce identical output on all output
-media while taking advantage of display hardware acceleration when
-available (eg. through the X Render Extension).
+The latest releases of cairo can be found at:
-Cairo provides a stateful user-level API with capabilities similar to
-the PDF 1.4 imaging model. Cairo provides operations including
-stroking and filling Bezier cubic splines, transforming and
-compositing translucent images, and antialiased text rendering.
+ http://cairographics.org/releases
-Cairo was once named Xr, (or Xr/Xc), so if you came looking for that
-software, you've found it.
+Snapshots of in-developmenent versions of cairo:
+
+ http://cairographics.org/snapshots
+
+The programming manual for using cairo:
+
+ http://cairographics.org/manual
+
+Mailing lists for contacting cairo users and developers:
+
+ http://cairographics.org/lists
+
+Answers to some frequently asked questions about cairo:
+
+ http://cairographics.org/FAQ
Dependencies
-------------
-Cairo currently requires the following supporting libraries:
+============
+The set of libraries needed to compile cairo depends on which backends
+are enabled when cairo is configured. Here are the dependencies for
+each backend:
+
+Surface backends:
- libpixman
- Xft2
- fontconfig
- freetype2
+ image backend
+ -------------
+ no dependencies
-Documentation
--------------
-There's not much documentation yet apart from the cairo.h header
-file. We'll be correcting that shortly.
+ glitz backend
+ -------------
+ glitz >= 0.4.4 http://freedesktop.org/Software/glitz)
-In the meantime, the cairo-demo module in CVS provides a few example
-programs using cairo. These may be helpful to a programmer just
-beginning with cairo. Also, familiarity with the PostScript imaging
-model will help in understanding cairo.
+ pdf backend
+ -----------
+ freetype >= 2.1.4 http://freetype.org
+
+ postscript backend
+ ------------------
+ zlib http://www.gzip.org/zlib
+
+ quartz backend
+ --------------
+
+
+ win32 backend
+ -------------
+
+ xcb backend
+ -----------
+ XCB http://xcb.freedesktop.org
+
+ xlib backend
+ ------------
+ Xrender >= 0.6 http://freedesktop.org/Software/xlibs
+
+Font backends:
+
+ freetype font backend
+ ---------------------
+ freetype >= 2.1.4 http://freetype.org
+ fontconfig http://fontconfig.org
+
+ win32 font backend
+ ------------------
+
+ atsui font backend
+ ------------------
+
+Compiling
+=========
+See the INSTALL document for build instructions.
History
--------
+=======
Cairo was originally developed by Carl Worth <cworth@cworth.org> 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 cairo or you have some ideas for how it could be
-improved, please feel free to send a message to cairo@cairographics.org
-
-Cairo 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://cairographics.org/cgi-bin/mailman/listinfo/cairo
+Since the original development, many more people have contributed to
+cairo. See the AUTHORS files for as complete a list as we've been able
+to compile so far.