README.rst

   1 PyLit
   2 *****
   3
   4 `Literate Programming`_ with reStructuredText_
   5
   6 .. epigraph::
   7
   8    The idea is that you do not document programs (after the fact), but
   9    write documents that *contain* the programs.
  10
  11    -- John Max Skaller
  12
  13 What is it
  14   PyLit (Python Literate) provides a plain but efficient tool for
  15   literate programming: a `bidirectional text/code converter`.
  16
  17 Install
  18   As `PyLit` is a pure Python module, installation is straightforward:
  19   Put `pylit.py`_ in Python's `Module Search Path`_.
  20
  21 .. _pylit.py: http://github.com/gmilde/PyLit/raw/master/pylit.py
  22
  23 Documentation
  24   See http://pylit.berlios.de
  25
  26   .. note:: The previous host of the PyLit project, berlios.de will close at
  27      the end of 2011. For the transition period, some links might not work.
  28
  29 Copyright
  30   © 2005, 2009 Günter Milde.
  31
  32 License
  33   PyLit is `free software`_, released under the `GNU General Public License`_
  34   (GPL) version 2 or later.
  35
  36   PyLit is distributed in the hope that it will be useful, but WITHOUT ANY
  37   WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  38   FOR A PARTICULAR PURPOSE.  See the `GNU General Public License`_ for more
  39   details.
  40
  41
  42 .. References
  43
  44 .. _Charming Python interview:
  45     http://www.ibm.com/developerworks/library/l-pyth7.html
  46 .. _bidirectional text/code converter: features.html#dual-source
  47 .. _literate programming: literate-programming.html
  48 .. _reStructuredText: http://docutils.sourceforge.net/rst.html
  49 .. _module search path:
  50     http://docs.python.org/tutorial/modules.html#the-module-search-path
  51 .. _`free software`: http://www.gnu.org/philosophy/free-sw.html
  52 .. _`GNU General Public License`: http://www.gnu.org/copyleft/gpl.html