1
0
mirror of https://github.com/moparisthebest/Simba synced 2024-11-10 11:25:06 -05:00

Simbadoc: Update documentation.

This commit is contained in:
Merlijn Wajer 2010-12-08 01:02:42 +01:00
parent 63dd0b8131
commit 8d6d6e039a
10 changed files with 36 additions and 24 deletions

View File

@ -1,8 +1,9 @@
Updater in Simba
================
A notice should appear in the Simba GUI, or you can alternatively
use Tools -> Update.
Don't forget to restart Simba when it has been updated!
As soon as there is an update for Simba, an extra icon will appear in the icon
bar. If you click it, an update window will appear. Click *update* and Simba
will update itself. Note that you will have to restart Simba to use the updated
version.
Alternatively you can use Tools -> Update to update.

View File

@ -1,10 +1,13 @@
Not Well Known Features
=======================
Simba has several features that are relatively unknown.
A few will be listed here.
Timestamped Writeln
-------------------
Simba can timestamp all your *writeln* calls.
Simba can timestamp all your debug.
.. code-block:: pascal

View File

@ -2,4 +2,4 @@ Simba Script Manager
====================
Community-created scripts will be available for download from the
Script Manager.
Script Manager. The script manager will appear in release 1.0.

View File

@ -60,6 +60,11 @@ This is the only supported way. You can simply do a svn checkout on the srl
repository, but if you can do that, then you should be able to set up SRL
yourself as well.
Setting up SRL 5 with Simba
---------------------------
This will follow later, upon SRL 5 release. (Which will be quite soon)
Installing scripts
------------------

View File

@ -0,0 +1,6 @@
libMML
======
libMML is an effort to bring the entire MML to a single standalone library.
MML usage will appear here soon.

View File

@ -6,6 +6,10 @@ provide scripts with the required functionality, but also used to pick colours
and select windows with Simba itself. The MML can run without any user
interface.
There currently is an effort to create a standalone library of the MML; called
*libMML*. This way any application can just load the library and use the MML
functionality.
The MML is split up in "Core" classes and "Addon" classes.
.. note::
@ -20,3 +24,4 @@ The MML is split up in "Core" classes and "Addon" classes.
mmlref/finder.rst
mmlref/bitmap.rst
mmlref/ocr.rst
mmlref/libmml

View File

@ -25,7 +25,7 @@ This means your settings.xml has become corrupt somehow, or Simba may not be
able to create it. If a settings.xml exists in your Simba directory, you can
delete it. (All your settings will be lost, but this shouldn't be a bug deal)
There is a bug report pending on this issue.
Note that this should no longer happen with Simba 750 and up.
..
Anything else?

View File

@ -2,3 +2,5 @@ Tutorial
=================
Complete tutorial.
.. What should be in here in the first place?

View File

@ -5,22 +5,8 @@ Currently Simba is still in its beta stages; this includes the documentation.
You will probably notice some parts of the documentation aren't finished or are just
plain missing.
So what's new in Simba? This documentation system.
Simba is being updated almost every day. To see changes as they are added, view
http://git.villavu.com/?p=simba.git;a=summary. Each commit should be explained
tersely in one line, and the exact changes can be viewed with "commitdiff". This
is a very verbose list of changes, large features or changes will be listed below:
Changelog for 715::
- Array Operator support. (=, <>, +)
- Foldable comments
- Add Disguise
- Add Status
- Add ClearDebugImg
- Add PosEx
- Add a new interpreter
- Fix Hypot
- Fix Extension Menu Checkbox
tersely in one line, and the exact changes can be viewed with "commitdiff".
A list of new features since 750 will show up here eventually.

View File

@ -64,6 +64,10 @@ some issues remain. The biggest issue is the interpreter that
executes your program. It is an external component and does not
play too well on Linux. Hopefully this will be improved upon soon.
There are plans on supporting interpreter for alternative languages such as
Python, these would largely resolve the current problems wit the PascalScript
interpreter on Linux/Mac.
Fast
~~~~
@ -91,5 +95,5 @@ Well Documented
~~~~~~~~~~~~~~~
Simba is well documented. (You're looking the documentation right now...)
There is still stuff left to document but overall the documentation is pretty
There is still a lot left to document but overall the documentation is pretty
good.