getting started with documentation

git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@2424 a592a061-630c-0410-9148-cb99ea01b6c8

diff --git a/src/mathed/README b/src/mathed/README
new file mode 100644 (file)
index 0000000..8f6b5af
--- /dev/null
+++ b/src/mathed/README
@@ -0,0 +1,37 @@
+
+Inset 'Xyz' is implemented by 'MathXyzInset' in 'math_xyzinset.[hC]'
+
+
+Inset hierarchy:
+                                   
+                                   MathInset   
+                                (abstract base)
+
+                         /            |             \
+
+              Dim                  Char                   MacroArg
+         (thing that need       (for things formerly 
+          the width_/ascent_     known as characters) 
+          /descent_ cache)
+        
+          /             \
+
+       Nest              Dots  Func  Space  Symbol
+  (for thing with      
+   nested content)     
+
+        |         \
+
+      Grid        Decoration   Delim   Frac  Macro  Root  Script  Sqrt
+
+      /   \
+
+ Array     "Matrix"
+         (base for eqnarray/align/...)
+
+
+
+There are only two "real LyXInsets" in here:
+
+Formula       - containing a pointer to a  MathMatrixInset (a misnomer...)
+FormulaMacro  - containing a pointer to a  MathMacroTemplate