docs: Add developer info
This commit is contained in:
parent
c8abbf58d7
commit
d00e22668e
1 changed files with 17 additions and 0 deletions
17
README.md
17
README.md
|
|
@ -164,6 +164,23 @@ default-formatter = jinja2
|
||||||
Can be any of the installed papis formatters, including custom ones
|
Can be any of the installed papis formatters, including custom ones
|
||||||
(though usually it will be `python`, which is also the default setting).
|
(though usually it will be `python`, which is also the default setting).
|
||||||
|
|
||||||
|
## For developers
|
||||||
|
|
||||||
|
To get started hacking on this little plugin it is easiest to either inject papis into the development environment:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
uv add --dev papis
|
||||||
|
```
|
||||||
|
|
||||||
|
Or, what I do, in turn inject it into your normal papis environment as editable: (`uv tool install --with-editable path/to/this/repo papis`).
|
||||||
|
|
||||||
|
Currently I can see two big things to do that would help this project out:
|
||||||
|
|
||||||
|
- A way to encode the options directly in the `ref-format` string, such as `ref-format = bbt:Author[1]year[2]TITLE[2, 20]` or something.
|
||||||
|
- Tests for all the little regex-y things we do. Tests for extracting the author, formatting the title, taking apart dates, and so on.
|
||||||
|
|
||||||
|
If you have the motivation to work on one of these let me know!
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
This plugin is a fairly simple adaption from [this](https://github.com/hrdl-github/papis/commit/b9b9c6eaa3de159e1b210174ef49e90a89271eb8) commit,
|
This plugin is a fairly simple adaption from [this](https://github.com/hrdl-github/papis/commit/b9b9c6eaa3de159e1b210174ef49e90a89271eb8) commit,
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue