1 files changed, 44 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..657a82b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,44 @@
+# [hitler.rip](https://hitler.rip)
+
+This is the source code for my website.
+
+Any code (scripts, etc.) is licensed under **AGPLv3-or-later**,
+the content is licensed under **CC BY-SA 4.0**.
+See `./licenses/` for more information.
+
+- - -
+
+## Build Instructions
+
+The pages on this website are written in Markdown.
+Thus we have to convert the Markdown to HTML first using **pandoc**.
+This project includes a build script that builds the website.
+
+```sh
+./build.sh
+```
+
+It also includes a wrapper around the build script that automatically configures my Debian/Nginx server, builds the website and publishes it.
+
+```sh
+./run.sh
+```
+
+Please note that you should place static content (such as images you link to) in `./dir/`. anything in `./dir/` will get copied without any modification to the `./web/` directory, which will be the root of your web page.
+
+custom directories are not supported yet. you will have to manually edit the build script.
+
+## To-Do
+
+- run.sh
+
+- title share options that link to id
+- add a copy button to code blocks
+
+- sort articles by date, add latest article to home page
+
+- allow user to create directories
+
+- 404 page
+
+- style contact information, style article list