1
0
mirror of https://github.com/moparisthebest/Simba synced 2024-11-28 20:12:16 -05:00

Start running spellcheck, I mean srsly. And think up some more conventions.

This commit is contained in:
R0b0t1 2010-06-13 16:17:00 -05:00
parent 5904dec440
commit fd3fe5325f
5 changed files with 30 additions and 23 deletions

9
Doc/sphinx/TODO Normal file
View File

@ -0,0 +1,9 @@
# Change a minus to a plus when something is being worked on.
# Remove it when you are done.
- Run spellcheck before you commit.
- Remove small/extraneous pages (merge them as a section with another).
- Create some conventions. Capitalize Simba whenever it occurs, and pick
either color or colour (it'd probably be best to use color, as the code
seems to use it).
- Find stuff to add to this list.

View File

@ -1,5 +1,5 @@
Getting Started With Simba Getting Started with Simba
========================== ==========================
This page will help you install Simba and highlight some basic Simba This page will help you install Simba and highlight some basic Simba

View File

@ -1,4 +1,4 @@
Complete tutorial Tutorial
================= =================
Complete tutorial Complete tutorial.

View File

@ -6,10 +6,11 @@ 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 you can design your own logic and steps that Simba will follow, based upon
certain input. certain input.
This "input" can vary greatly; from data in files to colours on the screen. This "input" can vary greatly; from data in files to colors and text on the screen.
.. This needs more info .. This needs more info
yep yep
Not really, you basically covered what Simba is in the above paragraph.
Simba can: Simba can:
* Find and read colours on the screen. * Find and read colours on the screen.
@ -17,9 +18,9 @@ Simba can:
this is the position of a found color or bitmap. this is the position of a found color or bitmap.
* Read and write files. * Read and write files.
* Connect to the internet to read websites and post data to them. * 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 * Read text on the screen and turn it into actual text. (Optical Character
Recognition) Recognition)
and much, more much. Start now by :ref:`installingsimba`. and much, much more. Start now by :ref:`installingsimba`.
If you want to know more about Simba, see :ref:`whysimba` If you want to know more about Simba, see :ref:`whysimba`

View File

@ -1,4 +1,4 @@
.. _whysimba: .. _whimsical:
Why Simba? Why Simba?
========== ==========
@ -6,7 +6,7 @@ Why Simba?
So why would you use Simba? So why would you use Simba?
For several reasons. Number one is probably the active community combined with For several reasons. Number one is probably the active community combined with
the open mindedness of the Simba developers. the open-mindedness of the Simba developers.
Simba is: Simba is:
@ -14,7 +14,7 @@ Free
~~~~ ~~~~
Simba is, and always will be free. Simba is, and always will be free.
It is free as in Free Beer ``and`` as in Freedom. It is free as in Free Beer **and** Freedom.
Simba is 100% free to use. In fact, we welcome you to share it with the Simba is 100% free to use. In fact, we welcome you to share it with the
rest of the world. rest of the world.
@ -25,7 +25,7 @@ license.
.. note:: .. note::
The source code allows everyone to see how the program actually The source code allows everyone to see how the program actually
works. Most developers choose not to share their source code and therefore works. Most developers choose not to share their source code and therefore
decide to hold knowledge back. The Simba developers highly disagree with decide to withhold knowledge. The Simba developers highly disagree with
this mentality and will fight for a world with free knowledge for this mentality and will fight for a world with free knowledge for
everyone. "Closed Source" as not sharing source code is called, is holding everyone. "Closed Source" as not sharing source code is called, is holding
back innovation and research in the world. back innovation and research in the world.
@ -34,22 +34,22 @@ license.
Extensible Extensible
~~~~~~~~~~ ~~~~~~~~~~
Simba supports both plugins in machine code as well as extensions written Simba supports both plug-ins in binary format as well as extensions written
in the Simba programming language. (Pascal) in the Simba programming language (which is Pascal-based).
This way one can easily extend Simba. See :ref:`writing-simba-extensions` This way one can easily extend Simba. See :ref:`writing-simba-extensions`
Reliable Reliable
~~~~~~~~ ~~~~~~~~
Simba is actively maintained by a team of knowledgable programmers. Simba is actively maintained by a team of knowledgeable programmers.
We as a team do our best to make Simba into a quality product. We as a team do our best to make Simba into a quality product.
However this does not guarantee a bug free program. However this does not guarantee a bug free program.
(Bug free programs don't exist) (Bug free programs don't exist)
Should you encouter a bug, please consider sending a bug report so we can Should you encouter a bug, please consider sending a bug report so we can
resolve the issue: :ref:`bugreport`. resolve the issue: :ref:`bug report`.
Cross Platform Cross Platform
~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~
@ -58,21 +58,18 @@ Simba has been written with freedom in mind and believes Simba
should not be limited to one platform, as that limits its users should not be limited to one platform, as that limits its users
to one platform as well. to one platform as well.
Currently the supported platforms are Windows and Linux. Currently the supported platforms are Windows and Linux with attempts
being made to port it to OSX (it may run on OSX if you install X11).
Even though we try hard to make Simba bug-free on all platforms, Even though we try hard to make Simba bug-free on all platforms,
some issues remain. The biggest issue is the component that some issues remain. The biggest issue is the interpreter that
executes your program. It is an external component and does not 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. play too well on Linux. Hopefully this will be improved upon soon.
Fast Fast
~~~~ ~~~~
The Simba developers have designed and written Simba with speed in mind. 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. However, some speed was sacrificed for readability and maintainability,
It often leads to instability and more bugs in the program. regardless, Simba is still quite fast.
For Simba, we have sacrificed some speed to make a more featureful
and stable program.
Nevertheless, Simba is quite fast.