summaryrefslogtreecommitdiff
path: root/tools/osxbuild/README.txt
diff options
context:
space:
mode:
authorchris.burns <chris.burns@localhost>2008-08-14 05:22:21 +0000
committerchris.burns <chris.burns@localhost>2008-08-14 05:22:21 +0000
commitc30bb0a07c2b17f36fdaabe906859dd51f9cb0f6 (patch)
treea04f78fa5281e79eaaadc42ab0ff8116911859ba /tools/osxbuild/README.txt
parentdcb2e6c797532d8b122a6f010aefd861fbccb2e1 (diff)
downloadnumpy-c30bb0a07c2b17f36fdaabe906859dd51f9cb0f6.tar.gz
Add install_and_test script for osxbuild. Update README.
Diffstat (limited to 'tools/osxbuild/README.txt')
-rw-r--r--tools/osxbuild/README.txt32
1 files changed, 29 insertions, 3 deletions
diff --git a/tools/osxbuild/README.txt b/tools/osxbuild/README.txt
index 9de0d740d..00600f190 100644
--- a/tools/osxbuild/README.txt
+++ b/tools/osxbuild/README.txt
@@ -1,6 +1,32 @@
-This directory contains the script to build a universal binary for
+==================================
+ Building an OSX binary for numpy
+==================================
+
+This directory contains the scripts to build a universal binary for
OSX. The binaries work on OSX 10.4 and 10.5.
- - bdist_mpkg v0.4.3 is required
+The docstring in build.py may contain more current details.
+
+Requirements
+============
+
+* bdist_mpkg v0.4.3
+
+Build
+=====
+
+The build script will build a numpy distribution using bdist_mpkg and
+create the mac package (mpkg) bundled in a disk image (dmg). To run
+the build script::
+
+ python build.py
+
+Install and test
+----------------
+
+The *install_and_test.py* script will find the numpy*.mpkg, install it
+using the Mac installer and then run the numpy test suite. To run the
+install and test::
+
+ python install_and_test.py
-See the docstring in build.py for more details.