From 0437750fa3c45cc7a2d7a81f7bbad3853c3174fd Mon Sep 17 00:00:00 2001 From: Syndamia Date: Sun, 18 Oct 2020 15:08:22 +0300 Subject: Made README more exhaustive --- README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 8795657..322307f 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,13 @@ # syndamiadotcom -Repository for my website + +Repository for my website. + +The pages of the website are (mostly) written in Markdown. Using [ssg](https://www.romanzolotarev.com/ssg.html) and [lowdown](https://kristaps.bsd.lv/lowdown/) they are generated into a **static** website. + +## Contents of this repository + +The `src` folder contains all of the website files, i.e. the pages, fonts, styles, images, etc. + +`install-ssg5-lowdown.sh` is a shell script that installs both ssg and lowdown. + +`generate.sh` is a shell script that automatically generates the website into a folder named "website". -- cgit v1.3.1-23-gd82d