More project docs + cleanup

Author: einarf

docs/controls.rst

@@ -8,6 +8,9 @@ Basic Keyboard Controls
 - ``ESC`` to exit
 - ``SPACE`` to pause the current time (tells the configured timer to pause)
 - ``X`` for taking a screenshot (output path is configurable in :doc:`settings`)
+- ``R`` reload shader programs (Needs configuration)
+- ``LEFT`` jump 10 seconds back in time
+- ``RIGHT`` jump 10 seconds forward in time
 
 Camera Controls
 ^^^^^^^^^^^^^^^
@@ -23,7 +26,6 @@ Simply apply the ``view_matrix`` of the camera to your transformations.
 - ``D`` strafe right
 - ``Q`` down the y axis
 - ``E`` up the y axis
-- ``R`` reload shader programs (Needs configuration)
 
 **Mouse Controls**
 

docs/settings.rst

@@ -167,7 +167,7 @@ You can create your own class handling this logic.
 More info in the :doc:`/user_guide/timeline` section.
 
 PROGRAM_DIRS/PROGRAM_FINDERS
--------------------
+----------------------------
 
 ``PROGRAM_DIRS`` contains absolute paths the ``FileSystemFinder`` will
 look for shaders programs.
@@ -281,7 +281,7 @@ The default scene loaders are:
     )
 
 DATA_DIRS/DATA_FINDERS
-------------------------
+----------------------
 
 Same principle as ``PROGRAM_DIRS`` and ``PROGRAM_FINDERS``.
 This is where the system looks for data files. These are

docs/user_guide/index.rst

@@ -8,8 +8,5 @@ User Guide
    effects
    project
    geometry
-   timers
-   timeline
-   pyrrmath
    performance
    audio

docs/user_guide/project.rst

@@ -74,6 +74,48 @@ The created effect instances can then be used by a timeline class deciding what
 effects should be rendered at any given point in time.
 The default timeline configured just grabs the first runnable effect it finds and render only that one.
 
+Timers
+------
+
+Timers are classes responsible for controlling the current time.
+It simply reports the number of seconds as a float since effect rendering started.
+Timers also need to support pausing and time seeking so we can
+freely move around in the timeline. 
+
+This time value is passed through the configured timeline class and forwarded
+to each active effect through their ```draw()`` method.
+We should assume time can move in any direction at any speed and suddenly
+jump forward and backwards in time.
+
+The default timer if not specified in settings:
+
+.. code-block:: shell
+
+    TIMER = 'demosys.timers.clock.Timer'
+
+Standard Timers
+^^^^^^^^^^^^^^^
+
+- :py:class:`demosys.timers.clock.Timer`: Default timer just tracking time in seconds using pythons ``time`` module.
+- :py:class:`demosys.timers.music.Timer`: Timer playing music reporting duration in the song
+- :py:class:`demosys.timers.rocket.Timer`: Timer using the rocket sync system
+- :py:class:`demosys.timers.rocketmusic.Timer`: Timer using the rocket sync system with
+  music playback
+
+You create a custom timer by extending :py:class:`demosys.timers.base.BaseTimer`.
+
+Timelines
+---------
+
+A timeline is a project responsible for knowing exactly when an effect instance
+is active based on the reported time from a timer.
+
+The current standard timelines are:
+
+* :py:class:`demosys.timeline.single.Timeline`: Grabs a the single effect instance from your project rendering it
+* :py:class:`demosys.timeline.rocket.Timeline`: The active status of each effect is decided by rocket
+
+New timeline classes can be created by extending :py:class:`demosys.timeline.base.BaseTimeline`.
 
 Effects Package Organization
 ----------------------------