aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorkj_sh6042026-02-16 01:43:05 -0500
committerkj_sh6042026-02-16 01:43:05 -0500
commiteb84775cf931a92fc26f5e7d66c74ac1521ca30b (patch)
tree511eb641510b6b69930d45f6fa97eebbdf431046 /README.md
parentafd82dc38510c6a47cfa227f40f1dae76e1a526c (diff)
refactor: update README
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 15 insertions, 2 deletions
diff --git a/README.md b/README.md
index 853cfda..1bf6ab6 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,12 @@
-# no name yet
+# likha-pdf
-simple web app that converts markdown to pdf using pandoc and lualatex.
+a simple web app that converts markdown to pdf using pandoc and lualatex.
+
+## features
+
+- markdown to pdf export
+- crappy image upload (but it works)
+- emoji-capable latex template
## requirements
@@ -8,10 +14,17 @@ simple web app that converts markdown to pdf using pandoc and lualatex.
- pandoc
- lualatex
+## image usage
+
+1. upload an image from the page
+2. click `insert into markdown`
+3. generate pdf
+
## run
```bash
+cd src/
python -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt