=================================
Welcome to GScrew's documentation!
=================================

Description
-----------
A Python module to manipulate Screws and Coscrews with geometrics algebra (Clifford's Algebra).

The full documentation is available on `readthedocs <https://gscrew.readthedocs.io/en/latest/>`_.

If you encounter any issue, feel free to open a ticket in the `bug tracker <https://github.com/GenScrew/GScrew/issues>`_.

Installation
------------
A Pypi package is available, please refer to the `Pypi page <https://pypi.org/project/GScrew/>`_ or enter ``pip install gscrew`` in a terminal.

Licence
-------
This project is under GNU General Public Licence v3.0 or later (GPLv3+).
Please see `LICENCE <https://github.com/GenScrew/GScrew/blob/master/LICENSE>`_ for more informations.

Content
-------
.. toctree::
    Home <self>
    Basic use <tutorials>
    Geometric algebra <geometric_algebra>
    Screws and coscrews <screw>