A Short Introduction to Navigatrix

Navigatrix is a Linux based OS and application suite for sailing cruisers (see http://navigatrix.net). This repository contains the reST source documents for the "Short Introduction to Navigatrix", a documentation that provides installation and configuration instructions plus an overview of the system and its applications.

Various output formats can be generated automatically from these sources using Sphinx, the Python documentation generator.

Overview of Files in this Repository

Root directory

• README.md: This file

• index.rst: The top-level source file of the documentation; all other documents reside in docs/.

• conf.py: Sphinx configuration file with a few customized parameters.

• Makefile: Sphinx generated Makefile that will build the documentation; for example, 'make html' will turn it into a set of web pages, 'make epub' will turn it into an ebook.

• make.bat: For Windows users.

• statcounter.py: Python script that will insert JavaScript snippets for StatCounter tracking into the html pages generated by Sphinx. use 'python satcounter.py --help' for more info.

• nxlogo_200.png: Logo used on the documentation's home page.

docs/

Contains the documentation source files.

_static/

Additional static layout elements.

files/

GIMP source files for some of the images used.