Summary Files Commits Branches @commit @diff @stats
path: root / README.md
diff options
context:
space:
mode:
Commit0437750fa3c45cc7a2d7a81f7bbad3853c3174fd (patch)
Author
 Syndamia <kamen.d.mladenov@protonmail.com>
2020-10-18 15:08:22 +0300
Committer
 Syndamia <kamen.d.mladenov@protonmail.com>
2020-10-18 15:08:22 +0300
Filesc3182282608eb58e9f79fec1730dc516a2c16e09 /README.md
syndamia.com-0437750fa3c45cc7a2d7a81f7bbad3853c3174fd.tar
syndamia.com-0437750fa3c45cc7a2d7a81f7bbad3853c3174fd.tar.gz
syndamia.com-0437750fa3c45cc7a2d7a81f7bbad3853c3174fd.zip
Parent27d1fe0a9695c57449c4a00fddeb239260862efc (diff)
Made README more exhaustive
1 files changed, 12 insertions, 1 deletions
-rw-r--r--README.md13
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".