Updated the documentation for installing Maestro (#308)

LLNL · Aug 21, 2020 · fda0aaf · fda0aaf
1 parent 325ac8b
commit fda0aaf
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 11 deletions.
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -26,6 +26,12 @@ increasingly complex workflow processes across platforms.
 Getting Started is Quick and Easy
 ==================================
 
+Maestro can be installed easily with ``pip``:
+
+.. code:: bash
+
+    pip install maestrowf
+
 Create a ``YAML`` file named ``study.yaml`` and paste the following content
 into the file:
 
@@ -97,7 +103,7 @@ And, running the study is still as simple as:
    :maxdepth: 4
    :caption: Contents:
 
-   getting_started
+   installing
    quick_start
    hello_world
    lulesh_breakdown

diff --git a/docs/source/getting_started.rst → docs/source/installing.rst b/docs/source/getting_started.rst → docs/source/installing.rst
@@ -1,5 +1,14 @@
-Getting Started
-================
+Installing Maestro
+==================
+
+Maestro can be installed via ``pip``:
+
+.. code:: bash
+
+    $ pip install maestrowf
+
+.. note:: Using a `virtualenv <https://virtualenv.pypa.io/en/stable/>`_ is recommended.
+
 
 Maestro Docker Container
 ************************
@@ -18,14 +27,6 @@ Once inside the Docker container, the following should bring up help::
 
 For more information on using Dockerfiles, checkout Docker's `documentation <https://docs.docker.com/engine/reference/builder/>`.
 
-Installing MaestroWF
-*********************
-
-MaestroWF can be installed via pip outside of Docker with the following::
-
-    $ pip install maestrowf
-
-.. note:: Using a `virtualenv <https://virtualenv.pypa.io/en/stable/>`_ is recommended.
 
 Once installed run::