####################################
The Embroidermodder Reference Manual
####################################

.. warning::

   This is very incomplete and cover hundreds of pages so it will take some
   time to complete. We hope to lift this warning by 2026.

   The reference manual is a living document: if you need to refer to
   the document please use the current live version of the website or download
   the current printable version.

   The documentation is based on all of the git repositories:
   when reporting issues in documention use the main repository
   (https://github.com/embroidermodder/embroidermodder).
   If there is reason to refer to manual specifically outside of the website
   repository use the abbreviation ``EMRM``.

.. raw:: latex

   \newpage

   \hspace{1cm}

   \vspace{8cm}

   Copyright \copyright{} 2011-2025 The Embroidermodder Team.

   \url{https://www.libembroidery.org}

   The Embroidermodder Team consists of all contributors to our projects
   at \url{https://github.com/Embroidermodder}. A copy of the contributor
   list is in the Credits section below
   and is maintained at \url{https://www.libembroidery.org/docs/credits}.

   \vspace{1cm}

   \hrulefill

   \vspace{1cm}

   Permission is granted to copy, distribute and/or modify this document
   under the terms of the GNU Free Documentation License, Version 1.3
   or any later version published by the Free Software Foundation;
   with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
   A copy of the license is included in the section entitled ``GNU
   Free Documentation License''.

   Longer code quotations may be copied, used and distributed under the terms of
   permissive free and open source licenses: either an MIT or zlib license
   for our internal code or a similar license for our dependencies.
   For details please read the ``LICENSE.md`` files in source code.

   \newpage

   \hspace{1cm}

   \vspace{6cm}

   \begingroup
   \begin{center}

   \emph{Dedicated to Jonathan Grieg.}
   
   \vspace{1cm}

   \emph{Open source software is made by people who care about good tools and the people who use them.}

   \vspace{1cm}

   \emph{You gave us many good ideas and worked hard to realise them.}
   
   \vspace{1cm}

   \emph{We'll be working on, and sharing, these creations for some time.}

   \vspace{1cm}

   \emph{Rock on!}

   \end{center}
   \endgroup

   \newpage

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   credits
   introduction
   changelog
   commands
   features
   history
   tutorials
   api
   development
   geometry
   needle
   unsorted
   bibliography
   LICENSE
   genindex

.. image::images/logo.png[The embroidery machine logo for the Embroidermodder 2 Project]