diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d8e8fc61bb..e93858f27d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -60,7 +60,7 @@ The following steps are tested on an Ubuntu system. ```bash $ make system-deps # intended to be used on Ubuntu (Debian). Let us know if you have a different OS. - $ make install + $ make install_dev ``` 4. Create a new branch with an informative name for your goal. diff --git a/Makefile b/Makefile index e3372d3071..077b4b23e5 100644 --- a/Makefile +++ b/Makefile @@ -1,5 +1,5 @@ .DEFAULT_GOAL := help -.PHONY: test system-deps dev-deps style lint install help docs +.PHONY: test system-deps dev-deps style lint install install_dev help docs help: @grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}' @@ -65,7 +65,10 @@ dev-deps: ## install development deps build-docs: ## build the docs cd docs && make clean && make build -install: ## install 🐸 TTS for development. +install: ## install 🐸 TTS + pip install -e .[all] + +install_dev: ## install 🐸 TTS for development. pip install -e .[all,dev] pre-commit install diff --git a/dockerfiles/Dockerfile.dev b/dockerfiles/Dockerfile.dev index 32e5c6d72f..3508932ce3 100644 --- a/dockerfiles/Dockerfile.dev +++ b/dockerfiles/Dockerfile.dev @@ -40,4 +40,4 @@ RUN pip install \ COPY . /root # Installing the TTS package itself: -RUN make install +RUN make install_dev diff --git a/docs/source/installation.md b/docs/source/installation.md index f0b2a00f19..405c436643 100644 --- a/docs/source/installation.md +++ b/docs/source/installation.md @@ -26,7 +26,12 @@ This is recommended for development and more control over 🐸TTS. git clone https://github.com/idiap/coqui-ai-TTS cd coqui-ai-TTS make system-deps # only on Linux systems. + +# Install package and optional extras make install + +# Same as above + dev dependencies and pre-commit +make install_dev ``` ## On Windows