From 5b8cce4a129881586b53dd6951e296041de92d69 Mon Sep 17 00:00:00 2001 From: Edgar Carrera Date: Wed, 19 Jan 2022 17:54:32 -0500 Subject: [PATCH] update readme --- README.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index bfa4b150..ac8ac1da 100644 --- a/README.md +++ b/README.md @@ -73,11 +73,10 @@ $ pip install -r requirements.txt $ mkdocs serve $ firefox http://127.0.0.1:8000 ``` - -You can run local tests by `./run-tests.sh`. Testing requires [a ruby installation](https://www.ruby-lang.org/en/documentation/installation/). You will also need to install the ruby gem awesome_bot by `gem install awesome_bot` and make sure that gem in accessible on your path. - You can exit from the virtual environment with `deactivate`. +You can run local tests executing `./run-tests.sh`. Testing requires [a ruby installation](https://www.ruby-lang.org/en/documentation/installation/). You will also need to install the ruby gem `awesome_bot` by issuing `gem install awesome_bot` and make sure that gem in accessible on your path. In addition, `npx` is also required by the test script. For this one should install `nodejs` and `npm`, and install it using the node package manager (npm) as `npm i npx`. + ### Note on markdown Markdownlint is used to check your markdown. However, it does not allow inline HTML. To temporarily allow it, you can wrap your inline HTML as follows: