summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authortarek <none@none>2009-10-09 14:58:40 +0200
committertarek <none@none>2009-10-09 14:58:40 +0200
commita4cbd95effcc0a57603bac0feffc44e6d5905e4c (patch)
tree71cbcf541ce0f37863b21a246842e29366815d14
parent739f071eff009685fc70d6caa464c3eb799c9365 (diff)
downloadpython-setuptools-git-a4cbd95effcc0a57603bac0feffc44e6d5905e4c.tar.gz
starting more docs
--HG-- branch : distribute extra : rebase_source : 9826d4158ddc98c84e56d2c54445ad9efba77be4
-rw-r--r--docs/index.txt1
-rw-r--r--docs/using.txt21
2 files changed, 22 insertions, 0 deletions
diff --git a/docs/index.txt b/docs/index.txt
index d7338702..e64b8c88 100644
--- a/docs/index.txt
+++ b/docs/index.txt
@@ -8,6 +8,7 @@ Contents:
roadmap
python3
+ using
setuptools
easy_install
pkg_resources
diff --git a/docs/using.txt b/docs/using.txt
new file mode 100644
index 00000000..192f1dc2
--- /dev/null
+++ b/docs/using.txt
@@ -0,0 +1,21 @@
+================================
+Using Distribute in your project
+================================
+
+To use Distribute in your project, the recommended way is to ship
+`distribute_setup.py` alongside your `setup.py` script and call
+it at the very begining of `setup.py` like this::
+
+ from distribute_setup import use_setuptools
+ use_setuptools()
+
+Another way is to add ``Distribute`` in the ``install_requires`` option::
+
+ from setuptools import setup
+
+ setup(...
+ install_requires=['distribute']
+ )
+
+
+XXX to be finished