From c38211b828dd31a444bbe1b055abb84079d9d44b Mon Sep 17 00:00:00 2001 From: telamonian Date: Fri, 21 Jun 2024 06:36:32 -0400 Subject: [PATCH] in inner project README, install instruction are now more generic/pypi agnostic --- {{cookiecutter.project_name}}/README.md | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/{{cookiecutter.project_name}}/README.md b/{{cookiecutter.project_name}}/README.md index 473d970..4d11f0d 100644 --- a/{{cookiecutter.project_name}}/README.md +++ b/{{cookiecutter.project_name}}/README.md @@ -1,13 +1,20 @@ -# {{cookiecutter.project_slug}} +# {{cookiecutter.project_name}} ## {{cookiecutter.project_short_description}} ## Install -To install the extension, execute: +After you download this extension, you can install it with: ```bash -pip install {{cookiecutter.project_slug}} +cd {{cookiecutter.project_name}} +pip install . +``` + +To install the latest version of the extension from github: + +```bash +pip install {{cookiecutter.project_name}}@git+https://github.com/{{cookiecutter.__gh_slug}} ``` ## Uninstall @@ -15,7 +22,7 @@ pip install {{cookiecutter.project_slug}} To remove the extension, execute: ```bash -pip uninstall {{cookiecutter.project_slug}} +pip uninstall {{cookiecutter.project_name}} ``` ## Develop @@ -23,6 +30,7 @@ pip uninstall {{cookiecutter.project_slug}} To install the dev dependencies and pre-commit (will run the ruff hook), do: ```bash +cd {{cookiecutter.project_name}} pip install -e .[dev] pre-commit install ```