Add README.t2t

This commit is contained in:
Matteo Cypriani 2012-11-08 19:14:41 +01:00
parent 7dc7b9af6e
commit 2898141f3b
1 changed files with 25 additions and 0 deletions

25
README.t2t Normal file
View File

@ -0,0 +1,25 @@
This is the OwlPS (Owl Positioning System) software distribution.
For an introduction to OwlPS, please consult ``doc/owlps.t2t``, which is
the documentation's entry point.
For copyright and license informations, please consult
``COPYRIGHT.t2t``.
For a guide to installing OwlPS, please consult ``INSTALL.t2t``.
The file ``CHANGELOG`` lists the changes occured in OwlPS, version by
version, since its early stages.
Finally, the file ``TODO.t2t`` is a list of potential work to do on the
system. If you are willing to contribute and are looking for ideas, that
can be a good start.
: Note on the t2t file extension
The documentation is provided as text files in the txt2tags format
(file extension ``*.t2t``). You can convert them to various formats
(HTML, man pages, etc.) using the ``txt2tags`` utility; if you mind
the markup tags, you can even strip them using the ``txt`` output.
``txt2tags`` is distributed at http://txt2tags.org/