From 70d92e6d042001dadd5d463f6aacc765ce44ed16 Mon Sep 17 00:00:00 2001 From: Alvie Rahman Date: Tue, 29 Jun 2021 19:27:31 +0100 Subject: [PATCH] add why? section to readme.md --- readme.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/readme.md b/readme.md index 63a9aed..c239891 100644 --- a/readme.md +++ b/readme.md @@ -4,6 +4,19 @@ View your notes as a static html site. ![](./screenshot.png) + +## Why? + +I want to be able to view my notes in a more convenient way. +I was already writing them in Pandoc markdown and could view them as PDFs but that wasn't quite +doing it for me: + +- It was inconvenient to flick through multiple files of notes to find the right PDF +- It was annoying to sync to my phone +- PDFs do not scale so they were hard to read on smaller screens +- Probably more reasons I can't think of right now + + ## Install 0. Install [Pandoc](https://pandoc.org/index.html) and [yq](https://github.com/mikefarah/yq)