.. SPDX-FileCopyrightText: 2025 Xavier Bordoy <somenxavier@posteo.net>
..
.. SPDX-License-Identifier: CC-BY-SA-4.0

About this project
###################


Aim
====

The aim of this project is to build a tool for generate worksheets of Mathematics
in automatic way and to have a small-size set of exercises and worksheets available
to teachers and students.

The project is free and open source which provides freedom to users and engage the
project itself providing the conditions which allow people to contribute to it.

Its secondary purpose is to keep simple: no databases, easy usage tools, etc.
Always thinking about users convenience.

The programs of worksheet.cc are implemented in `Python <https://www.python.org/>`__,
but we are language-neutral. Thus, we might think to migrate some parts to other
programming languages or write new components with we think are more suitable languages.

.. _license-label:

Licenses
========

-  All the code is licensed under `GNU General Public License 2.0 (GPL
   2.0 or
   later) <https://www.gnu.org/licenses/old-licenses/gpl-2.0-standalone.html>`__.
-  All documentation and generated documents are licensed under
   `Creative Commons Attribution-ShareAlike 4.0 International License
   (CC-BY-SA-4.0) <https://creativecommons.org/licenses/by-sa/4.0/deed.en>`__.


Contribution
=============

You can contribute to this project:

-  Using the `project <https://sr.ht/~xavierb/worksheet.cc/>`__: you can use
   :doc:`worksheets </docs/worksheets>`, or create worksheets using existing
   :doc:`exercises </docs/exercises>`. If you prefer you can program your
   scripts or programs using :doc:`low-level code </docs/api>`.
-  Spreading the project to reach more people.
-  Making suggestions, asking some questions or commenting whatever you
   want in mailing list: for `end users
   <https://lists.sr.ht/~xavierb/worksheet.cc-discuss>`__ or for `developers
   <https://lists.sr.ht/~xavierb/worksheet.cc-devel>`__.
-  Creating new exercises and sharing with others via `mailing
   list <https://lists.sr.ht/~xavierb/worksheet.cc-discuss>`__ (a web
   interface is planned :issue:`1`).
   If you did it, your exercises would satisfy the licenses of the
   project.
-  Contributing to `code <https://git.sr.ht/~xavierb/worksheet.cc>`__.
-  Money donations are not being accepted until project milestone "Alpha" were
   completed (see :doc:`/docs/milestones` and :issue:`2`).
- You can subscribe to low-level volume `announce list
  <https://lists.sr.ht/~xavierb/worksheet.cc-announce>`__.

You are always welcome.

Who is behind this?
===================

My name is `Xavier Bordoy <https://mathstodon.xyz/@somenxavier>`__. I am
a teacher of Mathematics. Nowadays I teach in adults school.

``worksheet.cc`` is my personal project. So no big corporation behind. I
make things on my spare time. Therefore, I will create new contents or
review old ones as I can, with no pre-established pace.

As a teacher, I’ve used a multitude of worksheets websites. But the
problem with those is that they either contain (excessive) advertising
or, when they have quality content, you can’t adapt it to your needs. 
And none of them are open source. I want to cover the gap.


.. toctree::
   :maxdepth: 2

   /docs/milestones.rst
   /docs/changelog.rst
   /docs/decisions.rst