summaryrefslogtreecommitdiff
path: root/INSTALL.rst
diff options
context:
space:
mode:
authorJulia Hansbrough <julia@flowerhack.com>2015-04-13 17:30:58 -0400
committerJulia Hansbrough <julia@flowerhack.com>2015-04-13 21:36:46 -0400
commitb65223d630789958de238f1d217fff8a022c5c67 (patch)
tree6f3c80e9ae1d04d6b20ca1c8421dc6fd747b9952 /INSTALL.rst
parent4ca37f747d9dcc21d6f85655895e1e997937a670 (diff)
downloadpyopenssl-git-b65223d630789958de238f1d217fff8a022c5c67.tar.gz
Updated installation docs
Diffstat (limited to 'INSTALL.rst')
-rw-r--r--INSTALL.rst19
1 files changed, 19 insertions, 0 deletions
diff --git a/INSTALL.rst b/INSTALL.rst
new file mode 100644
index 0000000..eea013b
--- /dev/null
+++ b/INSTALL.rst
@@ -0,0 +1,19 @@
+Installation
+============
+
+To install pyOpenSSL::
+
+ $ pip install pyopenssl
+
+If you are installing in order to *develop* on pyOpenSSL, move to the root directory of a pyOpenSSL checkout, and run::
+
+ $ pip install -e .
+
+
+Documentation
+=============
+
+The documentation is written in reStructuredText and built using Sphinx::
+
+ $ cd doc
+ $ make html