summaryrefslogtreecommitdiff
path: root/README.txt
diff options
context:
space:
mode:
authorDaniel Holth <dholth@fastmail.fm>2012-07-03 10:02:42 -0400
committerDaniel Holth <dholth@fastmail.fm>2012-07-03 10:02:42 -0400
commit3c73a94ebdbbe00451988b4d05426a6242e93baa (patch)
tree3ee9058c3948e17ee6d3e77bd78bae6260dce50e /README.txt
parent9f322dd1ccb78a66404e950af092d206ea3b331f (diff)
downloadwheel-3c73a94ebdbbe00451988b4d05426a6242e93baa.tar.gz
update README
Diffstat (limited to 'README.txt')
-rw-r--r--README.txt21
1 files changed, 20 insertions, 1 deletions
diff --git a/README.txt b/README.txt
index 0ab7c03..620065a 100644
--- a/README.txt
+++ b/README.txt
@@ -2,9 +2,28 @@
wheel
=====
-A binary package format for Python.
+A built-package package format for Python.
Can be installed with a patched version of pip from
https://github.com/dholth/pip
Requires a patched distribute from https://bitbucket.org/dholth/distribute
+
+Work on the spec is at https://docs.google.com/document/d/1mWPyvoeiqCrAy4UPNnvaz7Cgrqm4s_cfaTauAeJWABI/edit
+
+Why not egg?
+============
+
+Python's egg format predates the packging related standards we have today,
+the most important being PEP 376 "Database of Installed Python Distributions"
+which specifies the .dist-info directory (instead of .egg-info) and PEP 345
+"Metadata for Python Software Packages 1.2" which specifies how to express
+dependencies (instead of requires.txt in .egg-info).
+
+Wheel implements these things. It also provides a richer file naming
+convention that communicates the Python implementation and ABI as well as
+simply the language version used in a particular package.
+
+Unlike .egg, wheel will be a fully-documented standard at the binary level
+that is truly easy to install even if you do not want to use the reference
+implementation. \ No newline at end of file