[cairo-commit] [cairo-www] src/documentation.mdwn
cworth at freedesktop.org
Wed Jul 4 07:28:25 PDT 2007
src/documentation.mdwn | 47 +++++++++++++++++++++++++++--------------------
1 file changed, 27 insertions(+), 20 deletions(-)
Author: cworth <cworth at cworth.org>
Date: Wed Jul 4 07:28:25 2007 -0700
Organize primary and off-site sources. Add cookbook.
diff --git a/src/documentation.mdwn b/src/documentation.mdwn
index 4079ce0..e4beb0f 100644
@@ -3,17 +3,36 @@
Documentation for cairo is an area that could always be greatly
improved. Contributions are very welcome!
+Here are the most useful starting points:
- * [API reference manual](/manual/) not complete yet, but still
- useful. Please send suggestions for improvement to the [[cairo
- mailing list|lists]] or file bugs against the [cairo bugzilla
+ * [[Frequently asked questions|FAQ]]: Save yourself some time by
+ reading this early
-# Frequently Asked Questions
+ * [API reference manual](/manual/): Function-by-function reference
-We've begun maintaining a list of [[frequently_asked_questions|FAQ]]
-along with answers.
+ * [[Cookbook]]: Simple recipes for drawing
+Other information that might be of interest:
+ * [[Roadmap]]: Features planned for upcoming release
+ * [[Todo]]: Other ideas, (not yet on the [[roadmap]])
+ * [[Bibliography]]: Where the good ideas came from
+Here is a collection of pointers to articles that have been written
+elsewhere about cairo. Many of these articles might provide good
+inpiration for generating new primary-source documentation. As we
+improve the primary documentation to cover the same material that is
+covered below, we can drop items from the following list, (or at least
+move the links to some other page). For example, I'd really like to
+have one, really good tutorial hosted here on cairographics.org rather
+than having to rely on pointing to so many assorted tutorials, (some
+of which are quite stale).
@@ -63,18 +82,6 @@ along with answers.
and Keith Packard, presented at the Linux Symposium in July 2003.
This is from before Xr was renamed to cairo.
-# To Do List
-See the [[todo]] and [[roadmap]] files for areas where help is needed
-and development is heading.
-A few references to research paper that was referenced during the
-implementation of cairo have been collected as a cairo
-[[bibliography]]. This will be most useful for people working on cairo
-rather than for people learning how to use cairo.
More information about the cairo-commit