This commit is contained in:
parent
a9bc706501
commit
a8a649964d
1 changed files with 24 additions and 1 deletions
25
README.md
25
README.md
|
@ -15,7 +15,9 @@ It has a Forgejo CI build action, defined in `.forgejo/actions/build.yaml`.
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
Just replace `foo` by the name of the plugin below:
|
Just replace `foo` by the name of the plugin below.
|
||||||
|
|
||||||
|
With `fish`:
|
||||||
|
|
||||||
```fish
|
```fish
|
||||||
set NAME foo
|
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/settings.py
|
||||||
sed "s/plugin_template/$NAME/" -i src/$PNAME/workflows.py
|
sed "s/plugin_template/$NAME/" -i src/$PNAME/workflows.py
|
||||||
uv venv
|
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
|
||||||
```
|
```
|
Loading…
Add table
Add a link
Reference in a new issue