diff --git a/Doc/sphinx/features.rst b/Doc/sphinx/features.rst index 489ee1c..12aea5b 100644 --- a/Doc/sphinx/features.rst +++ b/Doc/sphinx/features.rst @@ -1,7 +1,11 @@ -Feature Overview -================ +Detailed Feature Overview +========================= + +Simba has some fancy features; the most basic operations as well as detailed +information about settings will be explained here. .. toctree:: + :maxdepth: 2 features/scriptmanager.rst features/autoupdate.rst @@ -10,5 +14,3 @@ Feature Overview features/ui.rst features/notwellknown.rst - -Most stuff here is probably misplaced anyway. diff --git a/Doc/sphinx/features/notwellknown.rst b/Doc/sphinx/features/notwellknown.rst index c7be836..fe9806d 100644 --- a/Doc/sphinx/features/notwellknown.rst +++ b/Doc/sphinx/features/notwellknown.rst @@ -1,6 +1,9 @@ Not Well Known Features ======================= +.. + TODO + Simba has several features that are relatively unknown. A few will be listed here. diff --git a/Doc/sphinx/gettingstarted.rst b/Doc/sphinx/gettingstarted.rst index 6f1f7d5..52f2f7c 100644 --- a/Doc/sphinx/gettingstarted.rst +++ b/Doc/sphinx/gettingstarted.rst @@ -18,10 +18,12 @@ minutes. Simba installer ~~~~~~~~~~~~~~~ -Everyone can download Simba at http://wizzup.org/simba/ -Go to download and download the Simba installer. +Everyone can get Simba at http://wizzup.org/simba/ -Once it is done downloading, simply run the installer and follow the steps. +Go to *Download* and download the Simba installer. + +Once it is done downloading, simply run the installer, follow the steps and +please make notice of the following note: .. note:: Simba will install to C:/ by default; if you want to install it @@ -35,18 +37,20 @@ Once it is done downloading, simply run the installer and follow the steps. Simba will probably tell you there is an update available. In this case, an update button will appear. Click it and the Simba Updater will show up. -Alternatively you can update Simba using Tools -> Update. +Alternatively you can update Simba using Tools -> Update which will update Simba +if there is a new update available. .. note:: - Updating Simba regularly is recommended. + Updating Simba as soon as an update is released is recommended. -Downloading Simba binary -~~~~~~~~~~~~~~~~~~~~~~~~ +Portable Simba Installation +~~~~~~~~~~~~~~~~~~~~~~~~~~~ -This is harder and not recommended. Steps on how to do this will follow later. +.. + TODO -For now, simply stick to the installer and update Simba after the install has -completed. +To get a portable installation at this time is not supported but will follow +sooner or later. Setting up SRL 4 with Simba --------------------------- @@ -54,7 +58,7 @@ Setting up SRL 4 with Simba If you were using the :ref:`simba-installer` then you can simply enable the ``SRL Updater`` extension. (Go to View -> Extensions and enable ``srl.sex``) -See :ref:`simbaext` for more information on Extensions. +See :ref:`simbaext` for more information on (other) Simba extensions. 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 @@ -68,6 +72,9 @@ This will follow later, upon SRL 5 release. Installing scripts ------------------ +.. + TODO + Scripts can be downloaded with the Script Manager, in Tools -> Script Manager. .. note:: diff --git a/Doc/sphinx/index.rst b/Doc/sphinx/index.rst index 28e48ef..30d9705 100644 --- a/Doc/sphinx/index.rst +++ b/Doc/sphinx/index.rst @@ -19,7 +19,6 @@ Contents: :maxdepth: 2 whatis.rst - whatsnew.rst whysimba.rst gettingstarted.rst troubleshooting.rst diff --git a/Doc/sphinx/libmml/intro.rst b/Doc/sphinx/libmml/intro.rst index fdd6020..2a8d5a7 100644 --- a/Doc/sphinx/libmml/intro.rst +++ b/Doc/sphinx/libmml/intro.rst @@ -12,7 +12,7 @@ libMML exactly? libMML is a loadable C-like library that provides most of the MML functionality. For the ones that do not know, MML is the core component for Simba that does all -the *computational* and *algorithmic* work. See :ref:`mml-ref` for more +the *computational* and *algorithmic* work. See :ref:`mmlref` for more information. To summarize, the MML covers: @@ -59,3 +59,42 @@ write - again - their own wrapper around libMML. This is what is being done with *pyMML*, the python libMML wrapper. It is still as much in development as libMML is, but the functionality exposed by libMML is succesfully used. +As of writing the pyMML usage looks like this, the passing around of a client +may be removed in a later stage, or at least have it's behaviour changed. + +.. code-block:: python + + DLL = MMLCore('../libmml.so') + + client = DLL.dll.create_client() + print 'Python Client: %d' % client + if client in (0, 1): + raise Exception('Could create a client'); + + c = Color(DLL, client) + + + ret = c.find((0, 0, 100, 100), 0) + print ret + + ret = c.find_all((0, 0, 100, 100), 0, tol=100) + print ret + + m = Mouse(DLL, client) + + print m[(Mouse.Pos, Mouse.Left, Mouse.Right)] + m[(Mouse.Pos, Mouse.Right)] = ((300,300), True) + + print m.getButtonStates() + sleep(0.5) + m.setPos((200,200)) + + sleep(2) + print 'Done' + + m[(Mouse.Left, Mouse.Right, Mouse.Middle)] = [False for x in range(3)] + for v in zip((Mouse.Left, Mouse.Right), m[(Mouse.Left, Mouse.Right)]): + print v + print m.getPos() + + del DLL diff --git a/Doc/sphinx/referencemml.rst b/Doc/sphinx/referencemml.rst index 4598022..7510d29 100644 --- a/Doc/sphinx/referencemml.rst +++ b/Doc/sphinx/referencemml.rst @@ -1,3 +1,5 @@ +.. _mmlref: + MML Reference ============= @@ -10,7 +12,7 @@ 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. +The MML is split up in "Core" classes and "Addon" classes. .. note:: This section needs to explain more on the core/addon differences, diff --git a/Doc/sphinx/scriptref/sound.rst b/Doc/sphinx/scriptref/sound.rst index fd06ac3..f45f31b 100644 --- a/Doc/sphinx/scriptref/sound.rst +++ b/Doc/sphinx/scriptref/sound.rst @@ -1,5 +1,5 @@ -.. _scriptref_web: +.. _scriptref_sound: Multimedia Functions ==================== diff --git a/Doc/sphinx/todo.rst b/Doc/sphinx/todo.rst index 4f0b792..bd86058 100644 --- a/Doc/sphinx/todo.rst +++ b/Doc/sphinx/todo.rst @@ -3,7 +3,6 @@ Documentation TODO ================== -* **WIP** - What's New. Changelog template added, fill it with stuff. * *Wizzup* - Script manager (non technical). * *Wizzup* - Script manager (technical). * Extend "Getting Started". Include downloading scripts from the manager. diff --git a/Doc/sphinx/troubleshooting.rst b/Doc/sphinx/troubleshooting.rst index e2dc2e3..c85620f 100644 --- a/Doc/sphinx/troubleshooting.rst +++ b/Doc/sphinx/troubleshooting.rst @@ -23,9 +23,10 @@ Simba crashes on start complaining about settings.xml 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) +delete it. (All your settings will be lost, but this shouldn't be a big deal) Note that this should no longer happen with Simba 750 and up. -.. +.. + TODO Anything else? diff --git a/Doc/sphinx/whatis.rst b/Doc/sphinx/whatis.rst index 6f16bcc..4782ec5 100644 --- a/Doc/sphinx/whatis.rst +++ b/Doc/sphinx/whatis.rst @@ -22,4 +22,11 @@ Simba can: and more. Start now by :ref:`installingsimba`. +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. + +Simba is being updated almost every day. To see changes as they are added, view +https://github.com/MerlijnWajer/Simba. + If you want to know more about Simba, see :ref:`whysimba` diff --git a/Doc/sphinx/whatsnew.rst b/Doc/sphinx/whatsnew.rst deleted file mode 100644 index 57d4c6f..0000000 --- a/Doc/sphinx/whatsnew.rst +++ /dev/null @@ -1,10 +0,0 @@ -What's new in Simba? -==================== - -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. - -Simba is being updated almost every day. To see changes as they are added, view -https://github.com/MerlijnWajer/Simba. Each commit should be explained -in one line, and the exact changes can be viewed with "commitdiff". diff --git a/Doc/sphinx/whysimba.rst b/Doc/sphinx/whysimba.rst index 3b2713d..26b19ef 100644 --- a/Doc/sphinx/whysimba.rst +++ b/Doc/sphinx/whysimba.rst @@ -11,15 +11,15 @@ the open-mindedness of the Simba developers. Free ~~~~ -Simba is, and always will be free. +Simba is, and always will be free. 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. -The source code to the program is freely available, under the GPL (v3) license. +The source code to the program is freely available, under the GPL (v3) license. -.. note:: +.. 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 withhold knowledge. The Simba developers highly disagree with @@ -39,19 +39,19 @@ This way one can easily extend Simba. See :ref:`writing-simba-extensions` Reliable ~~~~~~~~ -Simba is actively maintained by a team of knowledgeable 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. (Bug free programs don't exist) Should you encounter a bug, please consider sending a bug report so we can -resolve the issue: :ref:`bugreport`. +try to resolve the issue: :ref:`bugreport`. Cross Platform ~~~~~~~~~~~~~~ -Simba has been written with freedom in mind and believes Simba +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. @@ -59,7 +59,7 @@ 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, -some issues remain. The biggest issue is the interpreter that +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. @@ -94,5 +94,4 @@ Well Documented ~~~~~~~~~~~~~~~ Simba is well documented. (You're looking the documentation right now...) -There is still a lot left to document but overall the documentation is pretty -good. +There is still a lot left to document though.