2 files changed, 20 insertions(+), 1 deletions(-)
D README.org
A README.org
D README.org => README.org +0 -1
@@ 1,1 0,0 @@
-./src/index.org>
\ No newline at end of file
A README.org => README.org +20 -0
@@ 0,0 1,20 @@
+* ccw.icu
+This repo contains the feed source code for my website.
+
+To view the content of my web page,
+you can visit [[https://ccw.icu][ccw.icu]] or explore it [[./src/index.org][locally]].
+
+* Building
+** Dependencies
+- ~pandoc~
+- ~sed~
+- ~awk~
+- ~bash~
+
+** Deploy
+To generate the HTML build output,
+simply execute the ~build.sh~ file.
+Afterwards the build output can be found in the ~build/~ folder.
+
+To get a local server running,
+you can use ~serve build~