Add readme

1 files changed, 21 insertions, 0 deletions

diff --git a/README.txt b/README.txt
new file mode 100644
index 0000000..a13b460
--- /dev/null
+++ b/README.txt
@@ -0,0 +1,21 @@
+This site uses a static site generator.
+
+This is a fork from a static site generator put together by w. kennedy[1].
+
+To use it:
+
+- clone this repository
+- edit the file index.md
+- update index.html by running:
+
+	./build index.md
+
+- edit deploy.sh with address of webserver
+- deploy to your webserver with:
+
+	./deploy.sh
+
+This README is probably not enough to cover usage of the site generator, feel
+free to email me if you are trying to use it and have questions.
+
+[1] the post is titled 'converting Markdown files into a website', zumdar, 2022.