Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
caredg committed Jan 19, 2022
1 parent f9d7098 commit 5b8cce4
Showing 1 changed file with 2 additions and 3 deletions.
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down

0 comments on commit 5b8cce4

Please sign in to comment.