Add lots of README's.

12 files changed, 133 insertions, 0 deletions

diff --git a/src/display/README b/src/display/README
new file mode 100644
index 000000000..0a7475950
--- /dev/null
+++ b/src/display/README
@@ -0,0 +1,17 @@
+
+
+This directory contains code for rendering graphics to the
+canvas. This includes rendering of SVG elements (DrawingItem and
+derived classes) as well as rendering of control items -
+nodes/handles/lines (CanvasItem and derived classes).
+
+Currently we rely on the "Cairo" graphics library for rendering.
+
+To do:
+
+* Split into three directories: drawing, canvas, common.
+* Remove SPCurve.
+
+
+
+
diff --git a/src/helper/README b/src/helper/README
new file mode 100644
index 000000000..d9a6b90b4
--- /dev/null
+++ b/src/helper/README
@@ -0,0 +1,8 @@
+
+
+This directory contains a variety of helper code.
+
+To do:
+
+* Merge with 'util'.
+* Move individual files to more appropriate directories.
diff --git a/src/inkgc/README b/src/inkgc/README
new file mode 100644
index 000000000..30f4601f9
--- /dev/null
+++ b/src/inkgc/README
@@ -0,0 +1,8 @@
+
+
+This directory contains code related to the Boehm Gargage Collector.
+
+To do:
+
+* Replace this code with C++11 smart pointers.
+
diff --git a/src/livarot/README b/src/livarot/README
new file mode 100644
index 000000000..3e6f1384a
--- /dev/null
+++ b/src/livarot/README
@@ -0,0 +1,17 @@
+
+
+This directory contains path and shape related code. This code is
+partially replaced by lib2geom. We still rely on this code for:
+
+* Binary path operations.
+* Path offsetting.
+* Finding start and end positions for lines text inside a shape.
+
+To do:
+
+* Move needed functionality to lib2geom or independent functions.
+* Delete directory.
+
+(Livarot is a pungent French cow milk cheese.)
+
+
diff --git a/src/live_effects/README b/src/live_effects/README
new file mode 100644
index 000000000..827a62e59
--- /dev/null
+++ b/src/live_effects/README
@@ -0,0 +1,8 @@
+
+
+This directory contains our "Live Path Effects" which create new paths from an existing path, storing the original path for reuse.
+
+To do:
+
+* Move to a suitable subdirectory.
+
diff --git a/src/pixmaps/README b/src/pixmaps/README
new file mode 100644
index 000000000..5495fa268
--- /dev/null
+++ b/src/pixmaps/README
@@ -0,0 +1,6 @@
+
+This directory contains cursor xpm's and handles for resizing/skewing/rotating.
+
+To do:
+
+* Move to 'ui'.
diff --git a/src/svg/README b/src/svg/README
new file mode 100644
index 000000000..777f8b87e
--- /dev/null
+++ b/src/svg/README
@@ -0,0 +1,8 @@
+
+
+This directory contains SVG utilities.
+
+To do:
+
+* Move to "util/svg".
+* Clean up.
diff --git a/src/trace/README b/src/trace/README
new file mode 100644
index 000000000..c90353ec7
--- /dev/null
+++ b/src/trace/README
@@ -0,0 +1,8 @@
+
+
+This directory contains code for converting bitmap images to vector images.
+
+To do:
+
+* Move to an appropriate subdirectory.
+
diff --git a/src/ui/README b/src/ui/README
new file mode 100644
index 000000000..3929271b8
--- /dev/null
+++ b/src/ui/README
@@ -0,0 +1,21 @@
+
+
+This directory contains all the code related to the Graphical User Interface.
+
+To do:
+
+* Move all GTK related code here.
+* Better organize directories:
+
+  - cache
+  - dialog
+  - menu
+  - onscreen
+  - toolbar
+  - tools
+  - view?
+  - widget
+  -- basic
+  -- composite
+  -- etc.
+
diff --git a/src/util/README b/src/util/README
new file mode 100644
index 000000000..53530ad0c
--- /dev/null
+++ b/src/util/README
@@ -0,0 +1,9 @@
+
+
+This directory contains a variety of utility code.
+
+To do:
+
+* Merge with 'helper' into this direcotry.
+* Move individual files to more appropriate directories.
+* Split into three sub-directories: numeric, color, svg.
diff --git a/src/widgets/README b/src/widgets/README
new file mode 100644
index 000000000..5369dbd4b
--- /dev/null
+++ b/src/widgets/README
@@ -0,0 +1,11 @@
+
+
+This directory contains widgets written in 'C'.
+
+To do:
+
+* Replace 'C' widgets by 'C++' widgets.
+* Move toolbar widgets to 'ui/toolbar'.
+* Temporary move to 'ui/widgets/legacy'.
+
+
diff --git a/src/xml/README b/src/xml/README
new file mode 100644
index 000000000..d46e7e028
--- /dev/null
+++ b/src/xml/README
@@ -0,0 +1,12 @@
+
+
+This directory contains code that handles the XML tree.
+
+Classes to store the parsed XML of an SVG document. Fairly generic,
+and doesn't contain significant SVG-specific functionality. The main
+distinguishing features (from something like libxml++) are
+notifications about XML changes and undo functionality. This subsystem
+is garbage-collected. Because XML nodes were formerly C structures
+called SPRepr, the XML tree is sometimes called the "repr tree", and
+XML nodes "reprs" (short for "representation").
+