From 48e7226ecc7e4cf8a9cf67f49fcfd41ff8f9b700 Mon Sep 17 00:00:00 2001
From: emanuel <emanfrog@gmail.com>
Date: Tue, 4 Nov 2025 23:50:03 +0100
Subject: [PATCH] README oppdater

---
 README.md | 49 +++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 49 insertions(+)

diff --git a/README.md b/README.md
index e69de29..a486394 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,49 @@
+# ztlk (Zettelkasten)
+Et enkelt shell-script for å søke gjennom BibTeX-filer og åpne tilhørende PDF-er.
+
+Det er gitt navnet ztlk etter Zettelkasten på tysk, et kortsystem for å håndtere referanser som bl.a. Walter Benjamin brukte under produksjonen av *Passasjeverket*, se [Zettelkasten på Wikipedia](https://en.wikipedia.org/wiki/Zettelkasten).
+
+## Funksjonalitet
+Scriptet leser BibTeX-filer, viser dem i en meny, og lar deg:
+- Søke og velge referanser
+- Åpne tilhørende PDF-filer
+- Kopiere BibTeX-nøkler til utklippstavlen
+
+## Avhengigheter
+- `wmenu` - dmenu for Wayland
+- `wl-copy` - Wayland clipboard (fra wl-clipboard)
+- `sioyek` - PDF-leser
+- `awk` - For parsing av BibTeX-filer
+
+## Konfigurasjon
+Rediger følgende variabler i scriptet:
+```sh
+BIB_FIL="/sti/til/dine/*.bib"    # BibTeX-filer
+PDF_DIR="/sti/til/pdf/"          # PDF-mappe
+MENU_CMD="wmenu ..."             # Meny-kommando og styling
+FONT="Iosevka Term Light 8"      # Font
+PDF_CMD="sioyek"                 # PDF-leser
+```
+
+## Filstruktur
+PDF-filene må ha samme navn som BibTeX-nøklene:
+```
+@article{Smith2020,
+  ...
+}
+```
+→ PDF-fil: `Smith2020.pdf`
+
+## Bruk
+```sh
+./ztlk
+```
+1. Scriptet viser alle referanser i en søkbar meny
+2. Velg en referanse
+3. Hvis PDF finnes, åpner wmenu med følgende handlinger:
+   - `open` - Åpner PDF og kopierer nøkkelen
+   - `yank [key]` - Kopierer bare nøkkelen
+   - `..` - Går tilbake til hovedmenyen
+4. Hvis PDF ikke finnes, kopieres nøkkelen automatisk
+
+Nøkkelen kopieres i formatet `@Smith2020` for enkel innsetting i LaTeX/Markdown-dokumenter.