Update README

raul23 · Sep 22, 2020 · ea0c26f · ea0c26f
1 parent 095a4c2
commit ea0c26f
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 5 deletions.
diff --git a/README.rst b/README.rst
@@ -80,12 +80,13 @@ Dependencies
 
 Installation instructions 😎
 ============================
+.. TODO IMPORTANT update released version in step 2
 
 1. Make sure to update *pip*::
 
    $ pip install --upgrade pip
 
-2. Install the package ``SimulRPi`` with *pip*::
+2. Install the package ``SimulRPi`` (released version **0.1.0a1**) with *pip*::
 
    $ pip install SimulRPi
 

diff --git a/README_pypi.rst b/README_pypi.rst
@@ -80,12 +80,13 @@ Dependencies
 
 Installation instructions 😎
 ============================
+.. TODO IMPORTANT update released version in step 2
 
 1. Make sure to update *pip*::
 
    $ pip install --upgrade pip
 
-2. Install the package ``SimulRPi`` with *pip*::
+2. Install the package ``SimulRPi`` (released version **0.1.0a1**) with *pip*::
 
    $ pip install SimulRPi
 

diff --git a/docs/README_docs.rst b/docs/README_docs.rst
@@ -80,13 +80,14 @@ Dependencies
 
 Installation instructions 😎
 ============================
+.. TODO IMPORTANT update released version in step 2
 .. highlight:: none
 
 1. Make sure to update *pip*::
 
    $ pip install --upgrade pip
 
-2. Install the package ``SimulRPi`` with *pip*::
+2. Install the package ``SimulRPi`` (released version **0.1.0a1**) with *pip*::
 
    $ pip install SimulRPi
 
@@ -106,7 +107,8 @@ Installation instructions 😎
 
 .. note::
 
-   To install the **bleeding-edge version** of the ``SimulRPi`` package,
+   To install the **bleeding-edge version** (|version|) of the ``SimulRPi``
+   package,
    install it from its github repository::
 
       $ pip install git+https://github.com/raul23/SimulRPi#egg=SimulRPi

diff --git a/docs/README_template.t_rst b/docs/README_template.t_rst
@@ -124,6 +124,7 @@ Dependencies
 
 Installation instructions 😎
 ============================
+.. TODO IMPORTANT update released version in step 2
 <host name="readthedocs">
 .. highlight:: none
 </host>
@@ -132,7 +133,7 @@ Installation instructions 😎
 
    $ pip install --upgrade pip
 
-2. Install the package ``SimulRPi`` with *pip*::
+2. Install the package ``SimulRPi`` (released version **0.1.0a1**) with *pip*::
 
    $ pip install SimulRPi
 
@@ -168,7 +169,13 @@ Installation instructions 😎
 .. note::
 </host>
 
+<host name="github, pypi">
    To install the **bleeding-edge version** of the ``SimulRPi`` package,
+</host>
+<host name="readthedocs">
+   To install the **bleeding-edge version** (|version|) of the ``SimulRPi``
+   package,
+</host>
    install it from its github repository::
 
       $ pip install git+https://github.com/raul23/SimulRPi#egg=SimulRPi