From bcb59b93de2d3560f8db67276c874cfbf5a05107 Mon Sep 17 00:00:00 2001 From: Marty Oehme Date: Sat, 16 May 2020 19:02:39 +0200 Subject: [PATCH] [bibtex] Fix README Adding ever so important information and admonishments to the readme. --- bibtex/README.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/bibtex/README.md b/bibtex/README.md index 9763a32..9e06767 100644 --- a/bibtex/README.md +++ b/bibtex/README.md @@ -21,12 +21,15 @@ Bib-due itself allows 2 filtering options: *until* a certain date (`-u`), and *a Using priority is relatively self-explanatory: 1 is the highest priority, 3 the lowest (technically, no priority is the lowest). Choosing `-p3` means priority 1, 2, and 3 will be displayed. Choosing `-p1` will only display the highest priority items. -Using the date works as a cut-off for the future, and it uses gnu `date` to calculate the correct date. That makes things like `-u fri this week'` possible, showing only upcoming items until the end of the week. Read the `date` manual for more information. +Using the date works as a cut-off for the future, and it uses gnu `date` to calculate the correct date. That makes things like `-u 'fri this week'` possible, showing only upcoming items until the end of the week. Read the `date` manual for more information. +There will likely not be a new option for filtering dates *from* a certain point forward since I don't need it and before implementing more stuff what's there should be more solid. (and read your damn overdue texts!) -Again, this script will for now break when bibtex files are formatted in any way other than for example this entry: +Again, this script will (for now[^time]) break when bibtex files are formatted in any way other than what it expects. +An example of a working entry: + +[^time]: And probably for some time since I don't see myself sinking too much more time into this in the near future. I actually need to get some of the upcoming readings done that I can now list! 🙂 ``` - @InBook{Borhi2016, author = {László Borhi}, chapter = {1956: Self-Liberation}, @@ -40,7 +43,6 @@ Again, this script will for now break when bibtex files are formatted in any way priority = {prio1}, timestamp = {2020-05-08}, } - ``` Important fields are author, title, due, priority. These need to exist, and need to be ordered alphabetically. Otherwise there will probably be some breakage.