fix document for expansion generator

[mint/mint-lib.git] / README.rdoc

diff --git a/README.rdoc b/README.rdoc
index a68e047..9ba6fa3 100644 (file)
--- a/README.rdoc
+++ b/README.rdoc
@@ -15,7 +15,7 @@ This class represents an expression.
   p expression.to_latex #=> '5 \div 4'
   p expression.normalize #=> '5 div 4'
 
-=== Mint::Builder
+== Mint::Builder
 This class builds expression from string.
 
   input = Readline.readline('>')
@@ -27,41 +27,50 @@ This class builds expression from string.
     puts 'Please check your answer.'
   end
 
-=== Mint::Factory
-Factory generates problem generator.
-
-  Mint::Factory.create(:arithmetic)
-  #=> #<Mint::Generator::Arithmetic>
-
-=== Mint::Generator
+== Mint::Generator
 Problem generator.
 
-==== Base
-You must inheritance this class.
-and over wirte #generate_problem method.
-
-==== Arithmetic
-==== HighOrderExpression
+=== Factory
+Factory generates problem generator.
 
-=== Mint::Solver
+  Mint::Generator::Factory.create(:ordinary_arithmetic)
+  #=> #<Mint::Generator::OrdinaryArithmetic>
+
+* Base
+  * ArithmeticBase
+    * OrdinaryArithmetic
+    * DecimalArithmetic
+    * FractionalArithmetic
+    * FractionalExpressionArithmetic
+  * High_orderExpression_base
+    * Factorization
+    * Expansion
+  * PartialFractionExpansion
+
+== Mint::Solver
 Problem solver.
 
   Mint::Solver.set_engine Mint::Solver::Engine::Arithmetic
   Mint::Solver.solve('1 + 1')
   #=> 2
 
-==== Engines
-Solver engine
-
-===== Base
-You must inheritance this class.
-to make original engine.
-and over write #solve method.
-
-===== Arithmetic
-===== Factorization
-===== Expantion
-
-== TODO:
-Move description to code.
+=== Maxima
+Use Maxima to solve problem.
+
+===== Factory
+Factory generates problem solver.
+
+  Mint::Solver::Maxima::Factory.create(:ordinary_arithmetic)
+  #=> #<Mint::Solver::Maxima::OrdinaryArithmetic>
+
+* Base
+  * ArithmeticBase
+    * OrdinaryArithmetic
+    * DecimalArithmetic
+    * FractionalArithmetic
+    * FractionalExpressionArithmetic
+  * High_orderExpression_base
+    * Factorization
+    * Expansion
+  * PartialFractionExpansion