aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorlukeflo2024-10-05 14:43:12 +0200
committerlukeflo2024-10-05 14:43:12 +0200
commit6717d6a9087180754eda66f89b348ce62b313e1e (patch)
treeaf57905c9ba6e7ba39f7763b19961d968ad12b28 /README.md
parent57f85617c500865a4da6b557b2e4ba823e4b0c51 (diff)
downloadbibiman-6717d6a9087180754eda66f89b348ce62b313e1e.tar.gz
bibiman-6717d6a9087180754eda66f89b348ce62b313e1e.zip
layout overhaul, README
Diffstat (limited to 'README.md')
-rw-r--r--README.md21
1 files changed, 16 insertions, 5 deletions
diff --git a/README.md b/README.md
index 922d0c8..d77e956 100644
--- a/README.md
+++ b/README.md
@@ -26,7 +26,7 @@ If you use the symlink option, you have to make sure that the directory containi
You need to pass a single `.bib` file as first positional argument:
-`bibimand /path/to/bibfile.bib`
+`bibiman /path/to/bibfile.bib`
Of course, this can be aliased if you only use one main file. E.g. in `.bashrc`/`.zshrc`:
@@ -39,6 +39,7 @@ For now, `bibiman` only has some very basic features implemented which are impor
+ **Browse** through the bib entries using *Vim-like keybindings* and a *fuzzy search* mode.
+ **Filter** the bib entries by *keywords* (and afterwards filter further by fuzzy searching).
+ **Edit** the current entry by opening a *terminal-based editor* at the specific line
++ **Yank/Copy** the citekey of the current entry to the system clipboard.
Furthermore, I want to implement the following features:
@@ -72,13 +73,23 @@ The search mode uses the `nucleo-matcher` crate. Thus, *fuzzy searching* is enab
## Edit bib entry
-For now, the TUI only supports terminal-based editors. It searches the environment variables `VISUAL` and `EDITOR` in this order. The fallback solution is `vi`.
+For now, the TUI only supports editors set through the environment variables `VISUAL` and `EDITOR` in this order. The fallback solution is `vi`.
-Since this behaviour most likely supports UNIX-based systems (Linux, MacOS) it might not work under Windows. I can't test it on a Windows machine, thus, there might be unexpected errors with it.
+I've tested the following editors (set as value of `VISUAL`):
+
+- [X] **Helix**: `export VISUAL="hx"`
+- [X] **Vim/Neovim**: `export VISUAL="vim/nvim"`
+- [X] **Emacs (Terminal)**: `export VISUAL="emacs -nw"`
+- [X] **Nano**: `export VISUAL="nano"`
+- [X] **Emacs (GUI)**: `export VISUAL="emacs"` (open emacs in separate window, blocks the terminal running `bibiman` as long as emacs is opened)
+
+Feel free to try other editors. Important is that the editor supports the argument `+..` to set the line number that the cursor should be placed at. Otherwise, the functionality might not work properly.
+
+Since this behaviour is most likely supported on UNIX-based systems (Linux, MacOS) it might not work under Windows. I can't test it on a Windows machine, thus, there might be unexpected errors with it.
## Issues and code improvement
-This is my first Rust project and, thus, also a learning process. If you find any issues or code flaws, please open an issue. I plan to open PRs in the future when its a little bit less early alpha state.
+This is my first Rust project and, thus, also a learning process. If you find any issues or code flaws, please open an issue. I plan to make PRs possible in the future when its a little bit less early alpha state.
## Alternatives
@@ -88,6 +99,6 @@ I used `JabRef` for many years, but its way to bloated in my eyes. There exists
But there are also some TUI alternatives with slightly different approaches. Maybe one of these might fit *your* personal needs better:
-+ [bibman (Haskell)](https://codeberg.org/KMIJPH/bibman): A very nice TUI I also used for some times. It has way more features (export etc.) at the moment. The main difference is that its based on a multi file approach. If you also use a separate file per entry, look there!
++ [bibman (Haskell)](https://codeberg.org/KMIJPH/bibman): A very nice CLI program including a TUI I also used for some times. It has way more features (export etc.) at the moment. The main difference is that its based on a multi file approach. If you also use a separate file per entry, look there!
+ [bibman (Python)](https://github.com/ductri/bibman): A TUI written in Python with focus on Zotero-like functions. If you're uses to Zotero, this might be a good fit.
+ [bibman (Perl)](https://github.com/maciejjan/bibman): A fast and simple TUI written in good ol' Perl. It looks like back in the days, but seems not being maintained anymore