Merge branch 'master' of ssh://villavu.com:54367/simba

Doc/sphinx/bugreport.rst

@@ -10,27 +10,41 @@ click its link and add any information you can into the comments. If your bug do
 exist, follow these steps:
 
 1. Upon opening that page, you should see a "Report Issue" link. Click this.
+
 2. Now, you should select the project to report to. Use the following criteria:
+
 	- If the problem is with the GUI, choose "Simba".
+
 	- If the problem seems to be in the library, choose "MML".
+
 	- If the problem is not in one of the above or you know it is an SRL function
 	  causing the problem, choose "SRL".
+
    If you can not decide, choose "Simba". The developers can move the ticket as needed.
+
 3. Now, choose the Category that the bug is in. This should be self-explanatory; choose
    a topic related to what you were doing when the bug occured. Choose general if you
    are unsure. Developers can, again, change the ticket if required.
+
 4. Select the reproducability. If this is a request for a feature, choose "N/A".
+
 5. Severity should be ranked according to how much the bug affects the program.
    Crashes will be dealt with first, then blocks, etc. This step goes along with
    priority, which should be chosen along with the severity.
+
 6. Version, at this time, is not needed for Simba and MML issues. If the issue occurs
    with an older script, choose "SRL 4 Compatibility".
+
 7. Now write the summary of the bug. Choose something better than "Does not Work". If,
    for example, you were experiencing a crash of the program when trying to use the OCR
    to scan the character "~" on the 30th of February while you were woodcutting willows
    with an iron axe, a suitable Summary might be "Crash While Using OCR on Specific Char".
+
 8. Using the same example for above, a Description should explain the problem while being
    concise. This field is not the field for technical details, simply describe the problem.
+
 9. Include any technical details such as what exactly you did, etc. Use pictures if
    possible.
+
 10. Finally, hit submit. It should return successful.
+

Doc/sphinx/index.rst

@@ -6,6 +6,9 @@
 Welcome to the Simba documentation!
 ===================================
 
+.. note::
+    The documentation is still WIP (Work In Progress)
+
 Welcome to the Documentation for the Simba project.
 
 Contents:
@@ -21,8 +24,9 @@ Contents:
     troubleshooting.rst
     bugreport.rst
     tutorial.rst
-    reference.rst
+    referencescript.rst
-    scriptreference.rst
+    referencesimba.rst
+    referencemml.rst
     docdoc.rst
     todo.rst
     pymml.rst

Doc/sphinx/mmlref/bitmap.rst

@@ -0,0 +1,4 @@
+TMufasaBitmap Class
+===================
+
+

Doc/sphinx/mmlref/client.rst

@@ -0,0 +1,2 @@
+TClient Class
+=============

Doc/sphinx/mmlref/finder.rst

@@ -0,0 +1,4 @@
+TMFinder Class
+==============
+
+

Doc/sphinx/mmlref/iomanager.rst

@@ -0,0 +1,9 @@
+TWindow Class
+=============
+
+.. toctree::
+    :maxdepth: 2
+
+    linux.rst
+    windows.rst
+

Doc/sphinx/mmlref/ocr.rst

@@ -0,0 +1,4 @@
+TMOCR Class
+===========
+
+

Doc/sphinx/mmlref/os_linux.rst

@@ -0,0 +1,4 @@
+Linux Specific Code
+===================
+
+

Doc/sphinx/mmlref/os_windows.rst

@@ -0,0 +1,4 @@
+Windows Specific Code
+=====================
+
+

Doc/sphinx/referencemml.rst

@@ -0,0 +1,10 @@
+MML Reference
+=============
+
+The Mufasa Macro Library is the core library of Simba.
+
+.. toctree::
+    :maxdepth: 2
+
+    mmlref/client.rst
+    mmlref/iomanager.rst

Doc/sphinx/whatis.rst

@@ -20,6 +20,8 @@ Simba can:
     *   Connect to the internet to read websites and post data to them.
     *   Read text on the screen and turn it into actual text. (Optical Character
         Recognition)
+    *   Run pascal programs for you. If you're a bit creative you can have a lot
+        of fun stuff with Simba, you can even make a game in it.
 
 and much, much more. Start now by :ref:`installingsimba`.