path: root/README
diff options
authorGuillaume Seguin <>2009-10-24 15:16:58 +0200
committerGuillaume Seguin <>2009-10-24 15:16:58 +0200
commit16c34deeb3340aeb470958e2b2278c6c703fc5d5 (patch)
treefb2cb8149f7d38714beb9e0d18dfe8907fb36f34 /README
parent96657c777bbce773a8094c5dd718bfe201d05330 (diff)
Update documentationHEADmaster
Diffstat (limited to 'README')
1 files changed, 3 insertions, 3 deletions
diff --git a/README b/README
index 80428ce..52fe076 100644
--- a/README
+++ b/README
@@ -3,8 +3,8 @@ Python source files. It uses graphviz Python bindings and the dot layout for
graph generation and epydoc internals for source introspection.
The most basic usage of this software is to simply pass it the name of the
-modules you want to graph (you obviously need to be in the right directory) :
- $ python mymodule
+modules you want to graph (which have to be in your PythonPath) :
+ $ python mymodule mypackage
The result will be written to the uml.pdf file by default. The output filename
can be modified using the -o (or --output) option. The output format is set
using one of the --png, --pdf and --jpg options.
@@ -31,7 +31,7 @@ symmetric options are used (that is, using --all-methods together with
The distributed with this software shows how to correctly use the
docstrings. The example.png file shows the corresponding output, which was
produced by running
- $ python --png -o example.png -p "example."
+ $ python --png -o example.png -p "example." example
The umlpy.png file shows the software output for its own source file.