diff --git a/README.md b/README.md index 72a30c6a..87be1edd 100644 --- a/README.md +++ b/README.md @@ -398,8 +398,16 @@ You will need the following things properly installed on your computer. * `git clone https://github.com/ExpDev07/coronavirus-tracker-api.git` * `cd coronavirus-tracker-api` -* `pipenv shell` -* `pipenv install` + +1. Make sure you have [`python3.8` installed and on your `PATH`](https://docs.python-guide.org/starting/installation/). +2. [Install the `pipenv` dependency manager](https://pipenv.readthedocs.io/en/latest/install/#installing-pipenv) + * with [pipx](https://pipxproject.github.io/pipx/) `$ pipx install pipenv` + * with [Homebrew/Linuxbrew](https://pipenv.readthedocs.io/en/latest/install/#homebrew-installation-of-pipenv) `$ brew install pipenv` + * with [pip/pip3 directly](https://pipenv.readthedocs.io/en/latest/install/#pragmatic-installation-of-pipenv) `$ pip install --user pipenv` +3. Create virtual environment and install all dependencies `$ pipenv sync --dev` +4. Activate/enter the virtual environment `$ pipenv shell` + +And don't despair if don't get the python setup working on the first try. No one did. Guido got pretty close... once. But that's another story. Good luck. ## Running / Development @@ -408,11 +416,31 @@ You will need the following things properly installed on your computer. ### Running Tests -* `make test` +```bash +pipenv sync --dev +pipenv shell +make test +``` ### Linting -* `make lint` +```bash +pipenv sync --dev +pipenv shell +make lint +``` + +### Formatting + +```bash +pipenv run fmt +``` +or +```bash +pipenv shell +make fmt +``` + ### Building