===========================
The Great Reading Adventure
===========================

.. image:: _static/great-reading-adventure-logo@1x.png
  :width: 250
  :alt: Great Reading Adventure logo

`The Great Reading Adventure`_ is a robust, open source software designed to manage library reading
programs. The GRA is free to use, modify, and share. We hope you like it and will consider becoming
a part of the community.

The code is open source, and is `available on GitHub`_.

.. _The Great Reading Adventure: http://www.thegreatreadingadventure.com/
.. _available on GitHub: https://github.com/MCLD/greatreadingadventure/

.. note::
	This documentation is currently very incomplete. If you need help, please don't hesitate to
	contact developers and users in `The Great Reading Adventure discussions`_.

.. _The Great Reading Adventure discussions: https://github.com/MCLD/greatreadingadventure/discussions

This manual is split into several main sections:

* :ref:`intro-docs` - What is The Great Reading Adventure? How does it work?
* :ref:`install-docs` - installing and configuring The Great Reading Adventure software
* :ref:`setup-docs` - setting the software up to work with your reading program(s)
* :ref:`technical-docs` - technical documentation

.. _intro-docs:

.. toctree::
   :maxdepth: 1
   :caption: Introduction

   introduction/overview
   introduction/planning

.. _install-docs:

.. toctree::
   :maxdepth: 1
   :caption: Installation

   installation/system-requirements
   installation/requirements-checklist
   installation/create-the-database
   installation/configuration
   installation/install-the-software
   installation/upgrading

.. _setup-docs:

.. toctree::
   :maxdepth: 1
   :caption: Setup

   setup/administrator-account
   setup/roles-and-permissions
   setup/site-settings
   setup/adding-avatars
   setup/customizing-the-look-and-feel
   setup/performer-registration
   setup/email
   setup/triggers
   setup/vendor-codes

.. _technical-docs:

.. toctree::
   :maxdepth: 1
   :caption: Technical Documentation

   technical/appsettings
   technical/about