From bddbd67b1f67102ddb7ed7aa8977673ad6a35863 Mon Sep 17 00:00:00 2001 From: Paul Sanders Date: Wed, 10 Mar 2021 20:43:23 -0500 Subject: [PATCH] Remove dollar signs from code examples --- .code-samples.meilisearch.yaml | 2 +- CONTRIBUTING.md | 16 ++++++++-------- README.md | 6 +++--- 3 files changed, 12 insertions(+), 12 deletions(-) diff --git a/.code-samples.meilisearch.yaml b/.code-samples.meilisearch.yaml index acd9d397..fe6c9cfe 100644 --- a/.code-samples.meilisearch.yaml +++ b/.code-samples.meilisearch.yaml @@ -286,7 +286,7 @@ search_guide_2: |- }) getting_started_add_documents_md: |- ```bash - $ pip3 install meilisearch + pip3 install meilisearch ``` ```python diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7ab2deb3..4fb0b989 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -29,7 +29,7 @@ First of all, thank you for contributing to MeiliSearch! The goal of this docume ### Setup ```bash -$ pipenv install --dev +pipenv install --dev ``` ### Tests and Linter @@ -38,19 +38,19 @@ Each PR should pass the tests and the linter to be accepted. ```bash # Tests -$ docker pull getmeili/meilisearch:latest # Fetch the latest version of MeiliSearch image from Docker Hub -$ docker run -p 7700:7700 getmeili/meilisearch:latest ./meilisearch --master-key=masterKey --no-analytics=true -$ pipenv run pytest meilisearch +docker pull getmeili/meilisearch:latest # Fetch the latest version of MeiliSearch image from Docker Hub +docker run -p 7700:7700 getmeili/meilisearch:latest ./meilisearch --master-key=masterKey --no-analytics=true +pipenv run pytest meilisearch # Linter -$ pipenv run pylint meilisearch +pipenv run pylint meilisearch ``` Optionally tox can be used to run test on all supported version of Python and linting. ```bash -$ docker pull getmeili/meilisearch:latest # Fetch the latest version of MeiliSearch image from Docker Hub -$ docker run -p 7700:7700 getmeili/meilisearch:latest ./meilisearch --master-key=masterKey --no-analytics=true -$ pipenv run tox +docker pull getmeili/meilisearch:latest # Fetch the latest version of MeiliSearch image from Docker Hub +docker run -p 7700:7700 getmeili/meilisearch:latest ./meilisearch --master-key=masterKey --no-analytics=true +pipenv run tox ``` ### Want to debug? diff --git a/README.md b/README.md index 8aa3224b..496d1208 100644 --- a/README.md +++ b/README.md @@ -46,7 +46,7 @@ See our [Documentation](https://docs.meilisearch.com/learn/tutorials/getting_sta With `pip3` in command line: ```bash -$ pip3 install meilisearch +pip3 install meilisearch ``` ### Run MeiliSearch @@ -56,8 +56,8 @@ There are many easy ways to [download and run a MeiliSearch instance](https://do For example, if you use Docker: ```bash -$ docker pull getmeili/meilisearch:latest # Fetch the latest version of MeiliSearch image from Docker Hub -$ docker run -it --rm -p 7700:7700 getmeili/meilisearch:latest ./meilisearch --master-key=masterKey +docker pull getmeili/meilisearch:latest # Fetch the latest version of MeiliSearch image from Docker Hub +docker run -it --rm -p 7700:7700 getmeili/meilisearch:latest ./meilisearch --master-key=masterKey ``` NB: you can also download MeiliSearch from **Homebrew** or **APT**.