summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorAlex Grönholm <alex.gronholm@nextday.fi>2017-10-07 12:56:04 +0300
committerAlex Grönholm <alex.gronholm@nextday.fi>2018-07-17 15:02:49 +0300
commit749faff966a00d9045cf55630548b62a84287c11 (patch)
tree82197fe7ce9734be65436ce85498ffc57b3102b2 /docs
parent9de0ed0b848ab6e39ff4ac9ceead85b687496492 (diff)
downloadwheel-git-749faff966a00d9045cf55630548b62a84287c11.tar.gz
Finished the "quickstart" section of the new docs
Diffstat (limited to 'docs')
-rw-r--r--docs/quickstart.rst22
1 files changed, 22 insertions, 0 deletions
diff --git a/docs/quickstart.rst b/docs/quickstart.rst
index 764b157..a8bd251 100644
--- a/docs/quickstart.rst
+++ b/docs/quickstart.rst
@@ -1,2 +1,24 @@
Quickstart
==========
+
+To build a wheel for your setuptools based project::
+
+ python setup.py bdist_wheel
+
+The wheel will go to ``dist/yourproject-<tags>.whl``.
+
+To generate a key for signing wheels (you just need to do this **once**)::
+
+ wheel keygen
+
+To sign a wheel file::
+
+ wheel sign yourwheelfile.whl
+
+To verify the signature of a signed wheel file::
+
+ wheel verify yourwheelfile.whl
+
+To convert an ``.egg`` file to a wheel::
+
+ wheel convert youreggfile.egg