hump/docs/index.rst
Matthias Richter 945423f9f5 Update doc: Add list of functions to every module
Gives a nice overview and makes it easier to navigate the docs.
2017-11-19 21:32:56 +01:00

60 lines
1.4 KiB
ReStructuredText

**hump** - Helper Utilities for a Multitude of Problems
=======================================================
**hump** is a set of lightweight helpers for the awesome `LÖVE
<http://love2d.org>`_ game framework.
It will help to get you over the initial hump when starting to build a new
game.
**hump** does nothing that you couldn't do yourself.
But why should you?
You want to write games, not boilerplate!
**hump**'s components are so loosely coupled that every component is
independent of the others.
You can choose what you need and leave the rest behind.
hump wont judge.
**hump** just wants to make you happy.
Read on
-------
.. toctree::
:maxdepth: 2
hump.gamestate <gamestate>
hump.timer <timer>
hump.vector <vector>
hump.vector-light <vector-light>
hump.class <class>
hump.signal <signal>
hump.camera <camera>
license
Get hump
--------
You can view and download the individual modules on github: `vrld/hump
<http://github.com/vrld/hump>`_.
You may also download the whole packed sourcecode either in the `zip
<http://github.com/vrld/hump/zipball/master>`_ or `tar
<http://github.com/vrld/hump/tarball/master>`_ format.
Using `Git <http://git-scm.com>`_, you can clone the project by running:
git clone git://github.com/vrld/hump
Once done, tou can check for updates by running
git pull
Indices and tables
------------------
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`