Thomas Kluyver 11 anos atrás
pai
commit
2d55ae90b7
3 arquivos alterados com 47 adições e 1 exclusões
  1. 1 0
      MANIFEST.in
  2. 41 0
      README.rst
  3. 5 1
      setup.py

+ 1 - 0
MANIFEST.in

@@ -0,0 +1 @@
+include README.rst

+ 41 - 0
README.rst

@@ -0,0 +1,41 @@
+pynsist is a tool to build Windows installers for your Python applications. The
+installers bundle Python itself, so you can distribute your application to
+people who don't have Python installed.
+
+At present, pynsist requires Python 3.3 or above.
+
+For more information, see `the documentation <http://pynsist.readthedocs.org/en/latest/>`_
+and `the examples <https://github.com/takluyver/pynsist/tree/master/examples>`_.
+
+Quickstart
+----------
+
+1. Get the tools. Install `NSIS <http://nsis.sourceforge.net/Download>`_, and
+   then install pynsist from PyPI by running ``pip install pynsist``.
+
+2. Write a config file ``installer.cfg``, like this:
+
+   .. code-block:: ini
+   
+       [Application]
+       name=My App
+       version=1.0
+       # How to launch the app - this calls the 'main' function from the 'myapp' package:
+       entry_point=myapp:main
+       icon=myapp.ico
+
+       [Python]
+       version=3.4.0
+
+       [Include]
+       # Importable packages that your application requires, one per line
+       packages = requests
+            bs4
+            html5lib
+
+       # Other files and folders that should be installed
+       files = LICENSE
+           data_files/
+
+3. Run ``pynsist installer.cfg`` to generate your installer. If ``pynsist`` isn't
+   found, you can use ``python -m nsist installer.cfg`` instead.

+ 5 - 1
setup.py

@@ -1,8 +1,12 @@
 from distutils.core import setup
 
+with open('README.rst', 'r') as f:
+    readme=f.read()
+
 setup(name='pynsist',
       version='0.1',
       description='Build Windows installers for Python apps',
+      long_description=readme,
       author='Thomas Kluyver',
       author_email='thomas@kluyver.me.uk',
       url='https://github.com/takluyver/pynsis',
@@ -22,4 +26,4 @@ setup(name='pynsist',
           'Topic :: System :: Installation/Setup',
           'Topic :: System :: Software Distribution',
       ]
-)
+)