.. grunt documentation master file, created by
   sphinx-quickstart on Wed Jan 21 21:14:09 2026.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

GRUNT: Garmin RUN Tracking
==========================

.. figure :: logo/logo.png
    :align: left
    :width: 400

.. image:: https://img.shields.io/badge/License-GPLv3-blue.svg
.. image:: https://img.shields.io/badge/python-3.12%2B-blue
.. image:: https://img.shields.io/badge/linting-pylint-yellowgreen


GRUNT is a very small tool that I made to track my running stats. I have used this mainly to populate `this <https://romain-thomas-shef.github.io//runs/>`_ page. It is made using garmin running data that are downloaded by grunt.  



----

**Contribute:**
If you find a bug or would like to propose a new feature, I would appreciate if you could write an issue in the `github <https://github.com/Romain-Thomas-Shef/grunt/>`_ repository.
If you want to contribute to the development. If this is your case please have a look at the :doc:`dev_notes` and if you have any question you can write to and R.Thomas (romain.alexis.gerard.thomas@gmail.com). 

.. warning::

	**Copyright**

	GRUNT is a free software: you can redistribute it and/or modify it under
	the terms of the GNU General Public License as published by the Free Software Foundation,
	version 3 of the License.

	GRUNT is distributed without any warranty; without even the implied warranty of merchantability
	or fitness for a particular purpose.  See the GNU General Public License for more details.

	You should have received a copy of the GNU General Public License along with the program.
	If not, see http://www.gnu.org/licenses/ .

----


Table of content
----------------
.. toctree::
 :maxdepth: 1

 installation.rst
 get_started.rst
 dev_notes.rst