From: Evan Broder <broder@mit.edu>
Date: Wed, 18 Mar 2009 00:19:00 +0000 (-0400)
Subject: Add a brief README.
X-Git-Tag: 0.1.0~44
X-Git-Url: http://xvm.mit.edu/gitweb/invirt/packages/python-afs.git/commitdiff_plain/89a80026b2a9c9e540b04f8ba5ecbe929406434d?hp=dab10e1e9ed0f3617fdae1af24a189ef31f34699;ds=sidebyside

Add a brief README.

Signed-off-by: Evan Broder <broder@mit.edu>
---

diff --git a/README b/README
new file mode 100644
index 0000000..b88ab17
--- /dev/null
+++ b/README
@@ -0,0 +1,23 @@
+================
+Installing PyAFS
+================
+
+To install PyAFS, you will first need to install Cython_, which you
+can do by running:
+
+  $ easy_install Cython
+
+Once you've done that, to install PyAFS globally, run
+
+  $ python setup.py install
+
+If you want to build PyAFS without installing it globally, you may
+want to run:
+
+  $ python setup.py build_ext --inplace
+
+which will build the C extensions in place next to their source,
+allowing you to import the various modules, so long as your current
+working directory is the root of the PyAFS source tree.
+
+.. _Cython: http://cython.org/