Skip to content

Commit

Permalink
give instructions regarding how to use our scraper without docker closes
Browse files Browse the repository at this point in the history
  • Loading branch information
s-pace committed Nov 2, 2018
1 parent 8bcb25d commit 493712a
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,16 @@
Hello you,


## Install the scrapper without Docker

We do recommend the use of [pipenv][1] to install the whole python environment

- [Install pipenv][2]
- `pipenv --python 2.7 install`

You should be ready to go.


## Run the tests

To run the full test suite, run `./docsearch test`. Note that it requires that
Expand Down Expand Up @@ -42,4 +53,6 @@ git clone git@github.com:algolia/docsearch-configs.git configs/public
```
The CLI will then have more commands for you to run.

[1]: https://github.com/pypa/pipenv
[2]: https://pipenv.readthedocs.io/en/latest/install/#installing-pipenv

0 comments on commit 493712a

Please sign in to comment.