summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorJason R. Coombs <jaraco@jaraco.com>2015-11-27 12:43:20 -0500
committerJason R. Coombs <jaraco@jaraco.com>2015-11-27 12:43:20 -0500
commit9186dd6e15a7f7102ec4d3bf0f9c660ea6c7f082 (patch)
tree4f7333b7f60dc39a649f10855096f0dd114af7e7 /docs
parent63c3e2e1ba805f64ad251a90c1182bdd06e28a12 (diff)
downloadpython-setuptools-git-9186dd6e15a7f7102ec4d3bf0f9c660ea6c7f082.tar.gz
Add a bit more detail about the setup script and what to expect. Fixes #466.
Diffstat (limited to 'docs')
-rw-r--r--docs/setuptools.txt10
1 files changed, 8 insertions, 2 deletions
diff --git a/docs/setuptools.txt b/docs/setuptools.txt
index e2753cba..d6a62de8 100644
--- a/docs/setuptools.txt
+++ b/docs/setuptools.txt
@@ -112,10 +112,16 @@ the distutils. Here's a minimal setup script using setuptools::
)
As you can see, it doesn't take much to use setuptools in a project.
-Just by doing the above, this project will be able to produce eggs, upload to
+Run that script in your project folder, alongside the Python packages
+you have developed.
+
+Invoke that script to produce eggs, upload to
PyPI, and automatically include all packages in the directory where the
setup.py lives. See the `Command Reference`_ section below to see what
-commands you can give to this setup script.
+commands you can give to this setup script. For example,
+to produce a source distribution, simply invoke::
+
+ python setup.py sdist
Of course, before you release your project to PyPI, you'll want to add a bit
more information to your setup script to help people find or learn about your