aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorlukeflo2024-10-08 23:06:06 +0200
committerlukeflo2024-10-12 22:41:38 +0200
commit4321e52a95b398dd507092dd5b8aa9a14c2eee7b (patch)
tree27e14e3da99426964b252d63e5deb9ad409f9a57
parent2aaee4d89f7d8ee683a0d50f21723d908dec3e46 (diff)
downloadbibiman-4321e52a95b398dd507092dd5b8aa9a14c2eee7b.tar.gz
bibiman-4321e52a95b398dd507092dd5b8aa9a14c2eee7b.zip
updating README
-rw-r--r--Cargo.lock2
-rw-r--r--Cargo.toml2
-rw-r--r--README.md53
3 files changed, 36 insertions, 21 deletions
diff --git a/Cargo.lock b/Cargo.lock
index 5a5ff72..70e5ee8 100644
--- a/Cargo.lock
+++ b/Cargo.lock
@@ -83,7 +83,7 @@ dependencies = [
[[package]]
name = "bibiman"
-version = "0.1.1"
+version = "0.2.1"
dependencies = [
"arboard",
"biblatex",
diff --git a/Cargo.toml b/Cargo.toml
index c3f8f5c..26debff 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -1,6 +1,6 @@
[package]
name = "bibiman"
-version = "0.1.1"
+version = "0.2.1"
authors = ["lukeflo <lukeflo@some.email.not>"]
license = "GPL-3.0-or-later"
edition = "2021"
diff --git a/README.md b/README.md
index 55f57e2..57a4646 100644
--- a/README.md
+++ b/README.md
@@ -45,20 +45,18 @@ Of course, this can be aliased if you only use one main file. E.g. in
## Features
For now, `bibiman` only has some very basic features implemented which are
-important for my personal workflow:
-
-- **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:
-
-- [ ] **Open PDF**: Open related PDF file (`file` BibLaTeX key) with keypress.
-- [ ] **Open URL/DOI**: Open related DOI/URL with keypress.
+important for my personal workflow. There are more to come, the list will be
+updated:
+
+- [x] **Browse** through the bib entries using _Vim-like keybindings_ and a
+ _fuzzy search_ mode.
+- [x] **Filter** the bib entries by _keywords_ (and afterwards filter further by
+ fuzzy searching).
+- [x] **Edit** the current entry by opening a _terminal-based editor_ at the
+ specific line
+- [x] **Yank/Copy** the citekey of the current entry to the system clipboard.
+- [x] **Open PDF**: Open related PDF file (`file` BibLaTeX key) with keypress.
+- [x] **Open URL/DOI**: Open related DOI/URL with keypress.
- [ ] **Add Entry via DOI**: Download bibliographic metadata for inserted DOI
and add it to `.bib` file
@@ -72,11 +70,12 @@ Use the following keybindings to manage the TUI:
| **<kbd>g</kbd><kbd>G</kbd>** | Go to first/last entry |
| **<kbd>y</kbd>** | Yank/copy citekey of selected entry |
| **<kbd>e</kbd>** | Open editor at selected entry |
+| **<kbd>o</kbd>** \| **<kbd>u</kbd>** | Open related PDF \| URL/DOI |
| **<kbd>TAB</kbd>** | Switch between entries and keywords |
-| **<kbd>/</kbd>** \| **<kbd>Ctrl+f</kbd>** | Enter search mode |
+| **<kbd>/</kbd>** \| **<kbd>Ctrl-f</kbd>** | Enter search mode |
| **<kbd>Enter</kbd>** | Filter by selected keyword / Confirm search |
| **<kbd>ESC</kbd>** | Abort search / Reset current list |
-| **<kbd>q</kbd>** \| **<kbd>Ctrl-C</kbd>** | Quit TUI |
+| **<kbd>q</kbd>** \| **<kbd>Ctrl-c</kbd>** | Quit TUI |
## Search
@@ -105,10 +104,22 @@ 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,
+While 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.
+## Open connected files or links
+
+Now, `bibiman` also provides the possibility to open PDFs (as value of the
+`file` BibLaTeX field), as well as DOIs and URLs.
+
+For selecting the right program, it uses `xdg-open` on Linux, `open` on MacOS,
+and `start` on Windows. _MacOS and Windows are untested right now!_
+
+Furhtermore, DOIs have to begin with either `https://doi...` as full URL or
+`10.(...)` as regular DOI style. URLs work if they begin with either `http...`
+or with `www...`.
+
## Issues and code improvement
This is my first Rust project and, thus, also a learning process. If you find
@@ -137,4 +148,8 @@ Maybe one of these might fit _your_ personal needs better:
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
+ maintained anymore.
+- [cobib](https://github.com/mrossinek/cobib): Very elaborated bib manager with
+ CLI and TUI functions.
+- [papis](https://github.com/papis/papis): Powerful CLI tool for managing
+ bibliographies and documents. Has also some TUI features.