aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorlukeflo2024-10-14 09:40:38 +0200
committerlukeflo2024-10-14 09:40:38 +0200
commit30f05d7b6118a7438a58cce1778d5d111c90d062 (patch)
treeb715370d6f1308ff4ae3223021ac0f910954f36b
parent1445aa9f366ed0797f6869b436002bb062d9e1df (diff)
downloadbibiman-30f05d7b6118a7438a58cce1778d5d111c90d062.tar.gz
bibiman-30f05d7b6118a7438a58cce1778d5d111c90d062.zip
update README
-rw-r--r--Cargo.lock2
-rw-r--r--README.md14
-rw-r--r--test.bib4
3 files changed, 12 insertions, 8 deletions
diff --git a/Cargo.lock b/Cargo.lock
index c8ef416..c0d5821 100644
--- a/Cargo.lock
+++ b/Cargo.lock
@@ -83,7 +83,7 @@ dependencies = [
[[package]]
name = "bibiman"
-version = "0.2.2"
+version = "0.3.1"
dependencies = [
"arboard",
"biblatex",
diff --git a/README.md b/README.md
index cc4a926..fe14f91 100644
--- a/README.md
+++ b/README.md
@@ -3,7 +3,8 @@
`bibiman` is a simple terminal user interface for handling your BibLaTeX
database as part of a terminal-based scientific workflow.
-Here's a small impression how it looks and works:
+Here's a small impression how it looks and works (the `vhs` demo has a small
+glitch and doesn_t show all search results):
[![bibiman-demo-vhs.gif](https://i.postimg.cc/76zSmy35/bibiman-demo-vhs.gif)](https://postimg.cc/YGp4CZy7)
@@ -58,8 +59,11 @@ updated:
- [x] **Open related PDF** file (`file` BibLaTeX key) with keypress.
- [x] **Open related URL/DOI** with keypress.
- [x] **Scrollbar** for better navigating.
-- [ ] **Add Entry via DOI** to download bibliographic metadata for inserted DOI
- and add it to `.bib` file.
+- [ ] **Open related notes file** for specific entry.
+- [ ] **Add Entry via DOI** as formatted code.
+- [ ] **Support Hayagriva(`.yaml.`)** format as input.
+- [ ] **Implement config file** for setting some default values like main
+ bibfile, PDF-opener, or editor
## Keybindings
@@ -102,8 +106,8 @@ I've tested the following editors (set as value of `VISUAL`):
- [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.
+Feel free to try other editors and report. 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.
While this behaviour is most likely supported on UNIX-based systems (Linux,
diff --git a/test.bib b/test.bib
index 50ea05f..700f578 100644
--- a/test.bib
+++ b/test.bib
@@ -53,7 +53,7 @@
publisher = cup,
date = {1907},
editor = {Hicks, Robert Drew},
- keywords = {primary, ancient, philosophy},
+ keywords = {primary, ancient, philosophy, athens},
langid = {english},
langidopts = {variant=british},
annotation = {A \texttt{book} entry with an \texttt{author} and an \texttt{editor}},
@@ -117,7 +117,7 @@
langid = {english},
langidopts = {variant=american},
annotation = {A plain \texttt{book} entry},
- keywords = {chemistry},
+ keywords = {chemistry},
}
@book{averroes/bland,