From 2ae094477b6b7cfd460258f20e581c49a4c8e73c Mon Sep 17 00:00:00 2001 From: Merlijn Wajer Date: Sun, 13 Jun 2010 22:50:43 +0200 Subject: [PATCH] More documentation. --- Doc/sphinx/bugreport.rst | 6 +++ Doc/sphinx/gettingstarted.rst | 3 ++ Doc/sphinx/index.rst | 2 + Doc/sphinx/simbaref/extensions.rst | 2 + Doc/sphinx/whatis.rst | 25 +++++++++ Doc/sphinx/whysimba.rst | 84 ++++++++++++++++++++++-------- 6 files changed, 101 insertions(+), 21 deletions(-) create mode 100644 Doc/sphinx/bugreport.rst create mode 100644 Doc/sphinx/whatis.rst diff --git a/Doc/sphinx/bugreport.rst b/Doc/sphinx/bugreport.rst new file mode 100644 index 0000000..efe941c --- /dev/null +++ b/Doc/sphinx/bugreport.rst @@ -0,0 +1,6 @@ +.. _bugreport: + +Reporting Bugs +============== + +Report all bugs at http://bugs.villavu.com/ diff --git a/Doc/sphinx/gettingstarted.rst b/Doc/sphinx/gettingstarted.rst index 82c15eb..39c3043 100644 --- a/Doc/sphinx/gettingstarted.rst +++ b/Doc/sphinx/gettingstarted.rst @@ -1,9 +1,12 @@ + Getting Started With Simba ========================== This page will help you install Simba and highlight some basic Simba features. +.. _installingsimba: + Installing simba ---------------- diff --git a/Doc/sphinx/index.rst b/Doc/sphinx/index.rst index 826b217..31630fc 100644 --- a/Doc/sphinx/index.rst +++ b/Doc/sphinx/index.rst @@ -13,11 +13,13 @@ Contents: .. toctree:: :maxdepth: 2 + whatis.rst whatsnew.rst features.rst whysimba.rst gettingstarted.rst troubleshooting.rst + bugreport.rst tutorial.rst reference.rst scriptreference.rst diff --git a/Doc/sphinx/simbaref/extensions.rst b/Doc/sphinx/simbaref/extensions.rst index ec1fabb..7eccb90 100644 --- a/Doc/sphinx/simbaref/extensions.rst +++ b/Doc/sphinx/simbaref/extensions.rst @@ -1,3 +1,5 @@ +.. _writing-simba-extensions: + Writing Simba Extensions ======================== diff --git a/Doc/sphinx/whatis.rst b/Doc/sphinx/whatis.rst new file mode 100644 index 0000000..e6fe273 --- /dev/null +++ b/Doc/sphinx/whatis.rst @@ -0,0 +1,25 @@ +What Is Simba? +============== + +Simba is a program used to repeat certain (complicated) tasks. Typically these +tasks involve using the mouse and keyboard. Simba is programmable, which means +you can design your own logic and steps that Simba will follow, based upon +certain input. + +This "input" can vary greatly; from data in files to colours on the screen. + +.. This needs more info + yep + +Simba can: + * Find and read colours on the screen. + * Click or move the mouse to a specific position on the screen. Typically + this is the position of a found color or bitmap. + * Read and write files. + * Connect to the internet to read websites and post data to them. + * Read text on the screen and turn it into actual text. (Optical Text + Recognition) + +and much, more much. Start now by :ref:`installingsimba`. + +If you want to know more about Simba, see :ref:`whysimba` diff --git a/Doc/sphinx/whysimba.rst b/Doc/sphinx/whysimba.rst index 2c72f44..5989dbe 100644 --- a/Doc/sphinx/whysimba.rst +++ b/Doc/sphinx/whysimba.rst @@ -1,36 +1,78 @@ +.. _whysimba: + Why Simba? ========== -GEWOON MAN +So why would you use Simba? - * +For several reasons. Number one is probably the active community combined with +the open mindedness of the Simba developers. - Programmable - In fact, the only way to use it, is to write a program that Simba will execute. - * +Simba is: - Extensible - Simba supports both plugins in machine code as well as extensions written in the Simba programming language. (Pascal) - * +Free +~~~~ - Free (As in Free Beer and as in Freedom) +Simba is, and always will be free. +It is free as in Free Beer ``and`` as in Freedom. - Simba is 100% free to use. In fact, we welcome you to share it with the rest of the world. +Simba is 100% free to use. In fact, we welcome you to share it with the +rest of the world. - The source code to the program is also freely available, under the GPL license. - * +The source code to the program is also freely available, under the GPL +license. - Reliable - Simba is actively maintained by a team of knowledgable programmers. We as a team do our best to make Simba into a quality product. However: this does not guarantee a bug free program. (Bug free programs don't exist) - * +.. note:: + The source code allows everyone to see how the program actually + works. Most developers choose not to share their source code and therefore + decide to hold knowledge back. The Simba developers highly disagree with + this mentality and will fight for a world with free knowledge for + everyone. "Closed Source" as not sharing source code is called, is holding + back innovation and research in the world. - Cross Platform - Simba has been written with freedom in mind and believes Simba should not be limited to one platform, as that limits its users to one platform as well. Currently the supported platforms are Windows and Linux. +Extensible +~~~~~~~~~~ - Even though we try hard to make Simba bug-free on all platforms, some issues remain. The biggest issue is the component that executes your program. It is an external component and does not play too well on Linux. Hopefully we will be able to fix this soon. - * +Simba supports both plugins in machine code as well as extensions written +in the Simba programming language. (Pascal) - Quite fast - The Simba developers have designed and written Simba with speed in mind. However, focussing too much on speed is in reality not a good case. It often leads to instability and more bugs in the program. For Simba, we have sacraficed some speed to make a more featureful and stable program. +This way one can easily extend Simba. See :ref:`writing-simba-extensions` + +Reliable +~~~~~~~~ + +Simba is actively maintained by a team of knowledgable programmers. + +We as a team do our best to make Simba into a quality product. +However this does not guarantee a bug free program. +(Bug free programs don't exist) + +Should you encouter a bug, please consider sending a bug report so we can +resolve the issue: :ref:`bugreport`. + +Cross Platform +~~~~~~~~~~~~~~ + +Simba has been written with freedom in mind and believes Simba +should not be limited to one platform, as that limits its users +to one platform as well. + +Currently the supported platforms are Windows and Linux. + +Even though we try hard to make Simba bug-free on all platforms, +some issues remain. The biggest issue is the component that +executes your program. It is an external component and does not +play too well on Linux. Hopefully we will be able to fix this soon. + +Fast +~~~~ + +The Simba developers have designed and written Simba with speed in mind. +However, focussing too much on speed is in reality not a good case. +It often leads to instability and more bugs in the program. +For Simba, we have sacrificed some speed to make a more featureful +and stable program. + +Nevertheless, Simba is quite fast.