docs(index): Improve the index of the docs

ladybug-tools · Apr 5, 2021 · f52016e · f52016e
1 parent afaaba3
commit f52016e
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 31 deletions.
diff --git a/README.md b/README.md
@@ -10,9 +10,10 @@ It also includes microclimate mapping recipes, which spatially map thermal comfo
 
 ## Installation
 
-```console
-pip install lbt-recipes
-```
+`pip install -U lbt-recipes`
+
+To check if command line interface is installed correctly use `lbt-recipes viz` and you
+should get a `viiiiiiiiiiiiizzzzzzzzz!` back in response!
 
 ## Local Development
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -10,40 +10,16 @@ It also includes microclimate mapping recipes, which spatially map thermal comfo
 Installation
 ============
 
-```console
-pip install lbt-recipes
-```
-
-Local Development
-=================
-
-1) Clone this repo locally
-
-
-   ``git clone git@github.com:ladybug-tools/lbt-recipes``
-
-   # or
-
-   ``git clone https://github.com/ladybug-tools/lbt-recipes``
-
-
-2) Install dependencies::
-
-      cd lbt-recipes
-      pip install -r dev-requirements.txt
-      pip install -r requirements.txt
-
-
-3) Run Tests:
-
-   ``python -m pytest ./tests``
+To install the library use ``pip install -U lbt-recipes``.
 
+To check if the command line interface is installed correctly use ``lbt-recipes viz`` and you
+should get a ``viiiiiiiiiiiiizzzzzzzzz!`` back in response!
 
 lbt_recipes
 =============
 
 .. toctree::
-  :maxdepth: 2
+  :maxdepth: 4
 
   modules