瀏覽代碼

Add docs page describing examples

Thomas Kluyver 10 年之前
父節點
當前提交
32e67d13c7
共有 2 個文件被更改,包括 26 次插入0 次删除
  1. 25 0
      doc/examples.rst
  2. 1 0
      doc/index.rst

+ 25 - 0
doc/examples.rst

@@ -0,0 +1,25 @@
+Example applications
+====================
+
+Simplified examples
+-------------------
+
+The repository contains a number of simple examples for building applications
+with different frameworks:
+
+- `A console application <https://github.com/takluyver/pynsist/tree/master/examples/console>`_
+- `A tkinter application <https://github.com/takluyver/pynsist/tree/master/examples/tkinter>`_
+- `A PyQt4 application <https://github.com/takluyver/pynsist/tree/master/examples/pyqt>`_
+- `A PyGTK application <https://github.com/takluyver/pynsist/tree/master/examples/pygtk>`_
+- `A pygame application <https://github.com/takluyver/pynsist/tree/master/examples/pygame>`_
+
+Real-world examples
+-------------------
+
+These may illustrate more complex uses of pynsist.
+
+- The author's own application, `Taxonome <https://bitbucket.org/taxonome/taxonome/src>`_,
+  is a Python 3, PyQt4 application for working with scientific names for species.
+- `Spreads <https://github.com/jbaiter/spreads/tree/windows>`_ is a book scanning tool,
+  including a tkinter configuration system and a local webserver. Its use of
+  pynsist (see ``buildmsi.py``) includes working with setuptools info files.

+ 1 - 0
doc/index.rst

@@ -53,6 +53,7 @@ Contents
    faq
    releasenotes
    api/index
+   examples
 
 See also the `examples folder <https://github.com/takluyver/pynsist/tree/master/examples>`_
 in the repository.