diff --git a/README.md b/README.md index 4c21162..e4ec856 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,9 @@ It has a Forgejo CI build action, defined in `.forgejo/actions/build.yaml`. ## Usage -Just replace `foo` by the name of the plugin below: +Just replace `foo` by the name of the plugin below. + +With `fish`: ```fish set NAME foo @@ -43,4 +45,25 @@ sed "s/plugin_template/$NAME/" -i src/$PNAME/cli.py sed "s/plugin_template/$NAME/" -i src/$PNAME/settings.py sed "s/plugin_template/$NAME/" -i src/$PNAME/workflows.py uv venv +git init ``` + +Then, with `fish`: +```fish +. .venv/bin/activate.fish +uv sync +``` + +Or `bash`: +```bash +. .venv/bin/activate +uv sync +``` + +The package is ready. + +In a *knoc* development environment: +```fish +uv pip install -e ../$DNAME +knoc # Should display the new plugin's CLI tool +``` \ No newline at end of file