mirror of
https://github.com/moparisthebest/Simba
synced 2025-01-11 13:48:27 -05:00
More documentation.
This commit is contained in:
parent
e092f6aadd
commit
569596606f
@ -28,7 +28,7 @@ This will place the doc in html format in ``_build/html``.
|
|||||||
|
|
||||||
.. note::
|
.. note::
|
||||||
The build instructions are for Linux only. If you want to build the doc on
|
The build instructions are for Linux only. If you want to build the doc on
|
||||||
Windows, you are on your own. The sphinx resource site if probably a good
|
Windows, you are on your own. The sphinx resource site is probably a good
|
||||||
place to start.
|
place to start.
|
||||||
|
|
||||||
Writing documentation
|
Writing documentation
|
||||||
@ -54,7 +54,8 @@ you are writing a new chapter, then placing the file in the correct directory is
|
|||||||
something we'd like you to consider.
|
something we'd like you to consider.
|
||||||
|
|
||||||
If you wrote a chapter for the ``Simba Reference`` or ``Scripting Reference``
|
If you wrote a chapter for the ``Simba Reference`` or ``Scripting Reference``
|
||||||
part of the documentation, place it in the ``simbaref`` folder or in the
|
or ``Features``
|
||||||
``scriptref`` folder repectively.
|
part of the documentation, place it in the ``simbaref``, ``scriptref`` or
|
||||||
|
``features`` folder repectively.
|
||||||
Any other files can be put directly in the root of the sphinx folder.
|
Any other files can be put directly in the root of the sphinx folder.
|
||||||
(The same place as ``index.rst``)
|
(The same place as ``index.rst``)
|
||||||
|
@ -4,6 +4,7 @@ Feature overview
|
|||||||
.. toctree::
|
.. toctree::
|
||||||
|
|
||||||
features/scriptmanager.rst
|
features/scriptmanager.rst
|
||||||
|
features/autoupdate.rst
|
||||||
|
|
||||||
|
|
||||||
Most stuff here is probably misplaced anyway.
|
Most stuff here is probably misplaced anyway.
|
||||||
|
9
Doc/sphinx/features/autoupdate.rst
Normal file
9
Doc/sphinx/features/autoupdate.rst
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
Updater in Simba
|
||||||
|
================
|
||||||
|
|
||||||
|
A button appear, and a text message. blabla
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Don't forget to restart Simba when it has been updated, blabla
|
||||||
|
|
4
Doc/sphinx/features/scriptmanager.rst
Normal file
4
Doc/sphinx/features/scriptmanager.rst
Normal file
@ -0,0 +1,4 @@
|
|||||||
|
Simba Script Manager
|
||||||
|
====================
|
||||||
|
|
||||||
|
Non technical script manager doc.
|
@ -1,2 +1,67 @@
|
|||||||
Setting up Simba
|
Getting started with Simba
|
||||||
================
|
==========================
|
||||||
|
|
||||||
|
This page will help you install Simba and point you at some basic Simba
|
||||||
|
features.
|
||||||
|
|
||||||
|
Installing Simba
|
||||||
|
----------------
|
||||||
|
|
||||||
|
Installing Simba is pretty straighforward and will only take a couple of
|
||||||
|
minutes.
|
||||||
|
|
||||||
|
|
||||||
|
.. _simba-installer:
|
||||||
|
|
||||||
|
Simba installer
|
||||||
|
~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
Everyone can download Simba at http://wizzup.org/simba/
|
||||||
|
Go to download, and download the Simba installer.
|
||||||
|
|
||||||
|
Once it is done downloading, simple run the installer and follow the steps.
|
||||||
|
|
||||||
|
.. note::
|
||||||
|
Simba will install to C:/ by default; if you want to install it
|
||||||
|
somewhere else, make sure you select a different location in the installer.
|
||||||
|
|
||||||
|
Once you have installed Simba, make sure you update it at least once,
|
||||||
|
to get a more recent version of Simba.
|
||||||
|
|
||||||
|
Simba will tell you there is an update and an update button will appear.
|
||||||
|
Alternatively you can update Simba using Tools -> Update.
|
||||||
|
|
||||||
|
.. note::
|
||||||
|
Updating Simba regularly is recommended.
|
||||||
|
|
||||||
|
Simba binary
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
This is harder and not recommended. Steps on how to do this will follow later.
|
||||||
|
|
||||||
|
For now, simply stick to the installer and update
|
||||||
|
Simba after the install has completed.
|
||||||
|
|
||||||
|
Setting up SRL 4 with Simba
|
||||||
|
---------------------------
|
||||||
|
|
||||||
|
If you were using the :ref:`simba-installer` then you can simple enable the
|
||||||
|
``SRL Updater`` extension. (Go to View -> Extensions and enable srl.sex)
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
Installing scripts
|
||||||
|
------------------
|
||||||
|
|
||||||
|
Scripts can be downloaded with the Script Manager, in Tools -> Script Manager.
|
||||||
|
|
||||||
|
.. note::
|
||||||
|
The Script Manager is not finished yet.
|
||||||
|
|
||||||
|
Troubleshooting
|
||||||
|
---------------
|
||||||
|
|
||||||
|
If you run into problems that are not mentioned here, make sure you check out
|
||||||
|
the :ref:`Troubleshooting` page.
|
||||||
|
@ -17,6 +17,7 @@ Contents:
|
|||||||
features.rst
|
features.rst
|
||||||
whysimba.rst
|
whysimba.rst
|
||||||
gettingstarted.rst
|
gettingstarted.rst
|
||||||
|
troubleshooting.rst
|
||||||
tutorial.rst
|
tutorial.rst
|
||||||
reference.rst
|
reference.rst
|
||||||
scriptreference.rst
|
scriptreference.rst
|
||||||
|
@ -9,5 +9,3 @@ All Simba documentation should be in here.
|
|||||||
simbaref/scriptmanager.rst
|
simbaref/scriptmanager.rst
|
||||||
simbaref/extensions.rst
|
simbaref/extensions.rst
|
||||||
|
|
||||||
.. note::
|
|
||||||
This is not the same as a function reference... I think
|
|
||||||
|
12
Doc/sphinx/troubleshooting.rst
Normal file
12
Doc/sphinx/troubleshooting.rst
Normal file
@ -0,0 +1,12 @@
|
|||||||
|
.. _troubleshooting:
|
||||||
|
|
||||||
|
Troubleshooting
|
||||||
|
===============
|
||||||
|
|
||||||
|
This is a general troubleshooting page and will hopefully cover all potential
|
||||||
|
problem you may run into.
|
||||||
|
|
||||||
|
Problems when installing or starting Simba
|
||||||
|
------------------------------------------
|
||||||
|
|
||||||
|
Bugger.
|
@ -1,3 +1,8 @@
|
|||||||
What's new in Simba?
|
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 just
|
||||||
|
plain missing.
|
||||||
|
|
||||||
|
So what's new in Simba? This documentation system.
|
||||||
|
Loading…
Reference in New Issue
Block a user