Prepare for release

[pyderasn.git] / doc / install.rst

diff --git a/doc/install.rst b/doc/install.rst
index 144af21d2e0e23ecb2d7e3f57061b56b5b2827e7..7257589023c9b9b5e7204775ab5e406226f260f2 100644 (file)
--- a/doc/install.rst
+++ b/doc/install.rst
@@ -2,23 +2,29 @@ Install
 =======
 
 Preferable way is to :ref:`download <download>` tarball with the
-signature from `official website <http://pyderasn.cypherpunks.ru/>`__::
-
-    % wget http://pyderasn.cypherpunks.ru/pyderasn-3.13.tar.xz
-    % wget http://pyderasn.cypherpunks.ru/pyderasn-3.13.tar.xz.sig
-    % gpg --verify pyderasn-3.13.tar.xz.sig pyderasn-3.13.tar.xz
-    % xz -d < pyderasn-3.13.tar.xz | tar xf -
-    % cd pyderasn-3.13
-    % python setup.py install
+signature from `official website <http://www.pyderasn.cypherpunks.ru/>`__::
+
+    $ [fetch|wget] http://www.pyderasn.cypherpunks.ru/pyderasn-8.2.tar.xz
+    $ [fetch|wget] http://www.pyderasn.cypherpunks.ru/pyderasn-8.2.tar.xz.sig
+    $ gpg --verify pyderasn-8.2.tar.xz.sig pyderasn-8.2.tar.xz
+    $ xz --decompress --stdout pyderasn-8.2.tar.xz | tar xf -
+    $ cd pyderasn-8.2
+    $ python setup.py install
     # or copy pyderasn.py (+six.py, possibly termcolor.py) to your PYTHONPATH
 
 PyDERASN depends on `six <https://pypi.org/project/six/>`__ package
 for keeping compatibility with Py27/Py35. It is included in the tarball.
 You can also find it mirrored on :ref:`download <download>` page.
+``termcolor`` is an optional dependency used for output colourizing.
+``urwid`` is an optional dependency used for :ref:`interactive browser <browser>`.
 
-You could use PIP (**no** authentication is performed!)::
+You could use pip (**no** OpenPGP authentication is performed!) with PyPI::
 
-    % pip install pyderasn
+    $ cat > requirements.txt <<EOF
+    pyderasn==8.2 --hash=sha256:TO-BE-FILLED
+    six==1.14.0 --hash=sha256:236bdbdce46e6e6a3d61a337c0f8b763ca1e8717c03b369e87a7ec7ce1319c0a
+    EOF
+    $ pip install --requirement requirements.txt
 
 You have to verify downloaded tarballs integrity and authenticity to be
 sure that you retrieved trusted and untampered software. `GNU Privacy
@@ -34,7 +40,7 @@ resources.
           2ED6 C846 3051 02DF 5B4E  0383 04A9 33D1 BA20 327A
     uid   PyDERASN releases <pyderasn@cypherpunks.ru>
 
-    % gpg --auto-key-locate dane --locate-keys pyderasn at cypherpunks dot ru
-    % gpg --auto-key-locate wkd --locate-keys pyderasn at cypherpunks dot ru
+    $ gpg --auto-key-locate dane --locate-keys pyderasn at cypherpunks dot ru
+    $ gpg --auto-key-locate wkd --locate-keys pyderasn at cypherpunks dot ru
 
 .. literalinclude:: ../PUBKEY.asc