==========
Foundation
==========

If the Code Craftsmen have produced anything useful, we realize that
this is only possible because we are `standing on the shoulders of
giants`_.  Software is not created in a vacuum: each piece is built on
the code and ideas that have come before it.  The following external
software projects serve as a foundation for our `code crafting tools
<software>`.  Although this list is by no means exhaustive, it serves
as an overview of the software dependencies and provides links to
relevant local and upstream documentation.

Documentation Generation Tools
==============================

.. _sphinx:

`Sphinx <sphinx-notes>`
  Documentation generation tool originally created for the generating
  the `Python <python>` language documentation
  
.. _doxygen:

`Doxygen <doxygen-docs_>`_
  Documentation generation tool for extracting API documentation from C++
  source files
  
Build Tools
===========

.. _make:

`GNU Make <make-docs_>`_
  The granddaddy of all build tools

Python Packages
===============

.. _lark:

`Lark <lark-notes>`
  A parsing toolkit for `Python <python>`
  
C++ Utility Libraries
=====================

.. _eigen:

`Eigen <eigen-site_>`_
  Open-source C++ matrix library
  
.. _libavoid:

`libavoid <libavoid-notes>`
  Cross-platform C++ library providing fast, object-avoiding
  orthogonal and polyline connector routing for use in interactive
  diagram editors

.. _qt:

`Qt <qt-notes>`
  Cross-platform C++ library for constructing graphical user interfaces

.. _tclap:

`TCLAP <tclap-site_>`_
  Templatized C++ command-line parsing library

Python Development Tools
========================

.. _pip:

`pip <pip-site_>`_
  The package installer for `Python <python>`

.. _virtualenv:

`virtualenv <virtualenv-site_>`_
  Tool for creating isolated `Python <python>` environments

.. _virtualenvwrapper:

`virtualenvwrapper <virtualenvwrapper-notes>`
  Set of extensions to the `virtualenv <virtualenv>` tool that
  includes wrappers for creating and deleting `Python <python>`
  virtual environments

Compilers and Interpreters
==========================

.. _python:

`Python 3 <python-notes>`
  A popular, productive, high-level language

.. _gcc:

`GCC <gcc-site_>`_
  The GNU Compiler Collection

Operating Systems
=================

.. _linux:

`Linux <linux-site_>`_
  A free and open-source operating system kernel
  
.. _gnu:

`GNU <gnu-site_>`_
  A Unix-like operating system that is free software
  
.. _ubuntu:

`Ubuntu <ubuntu-notes>`
  An open-source operating system distribution built on `Linux
  <linux>` and `GNU <gnu>` software
  
.. _xenomai:

`Xenomai <xenomai-notes>`
  Free software project focused on building a real-time framework for
  the :ref:`Linux <Linux>` platform

.. _rtems:

`RTEMS <rtems-notes>`
  Embedded, open-source, real-time operating system

.. _config-preempt-rt:

`CONFIG_PREEMPT_RT <config-preempt-rt-site_>`_
  `Linux <linux>` patch set for improved real-time performance

.. _posix:

`POSIX <posix-docs_>`_
  Portable operating system standard, based on Unix
  
Source Code Management
======================

.. _git:

`Git <git-notes>`
  A free and open source distributed version control system

Web Services
============

.. _pypi:

`Python Package Index (PyPI) <pypi-site_>`_
  A repository of software for the Python programming language
  
.. _github:

`GitHub <github-site_>`_
  A popular website for hosting open-source code repositories

.. _read-the-docs:

`Read the Docs <read-the-docs-site_>`_
  A popular website for hosting open-source software documentation

.. _standing on the shoulders of giants:
   https://en.wikipedia.org/wiki/Standing_on_the_shoulders_of_giants
.. _doxygen-docs: https://www.doxygen.org
.. _make-docs: https://www.gnu.org/software/make/manual/html_node/index.html
.. _eigen-site: http://eigen.tuxfamily.org
.. _tclap-site: http://tclap.sourceforge.net
.. _pip-site: https://pip.pypa.io
.. _virtualenv-site: https://pypi.org/project/virtualenv
.. _gcc-site:  https://gcc.gnu.org
.. _linux-site: https://www.kernel.org
.. _gnu-site: https://www.gnu.org
.. _config-preempt-rt-site: https://rt.wiki.kernel.org
.. _posix-docs: https://en.wikipedia.org/wiki/POSIX
.. _pypi-site: https://pypi.org
.. _github-site: https://github.com
.. _read-the-docs-site: https://readthedocs.org