From 13d06c7c19129d5fb319d1871427dc70135f82f0 Mon Sep 17 00:00:00 2001
From: Arslaan Pathan <arslaan@arslaancodes.com>
Date: Thu, 20 Aug 2026 23:17:11 +1200
Subject: [chore/docs] fill in README oh and also licensing

---
 README.md | 50 +++++++++++++++++++++++++++++++++++++++++++++++---
 1 file changed, 47 insertions(+), 3 deletions(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index a6e33da..7403c5e 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,48 @@
-# arslaancodes
+# Arslaan's Website v3
+
+The third iteration of my personal website! Live at https://v3.arslaancodes.com 
+
+> Note: If you are viewing this repository on GitHub, please take note that the GitHub repository is merely a mirror for Hack Club Stardance and will probably not be updated once I ship the project.
+
+## Features
+- Built with Zola Static-site-generator (v0.23)
+- Catppuccin Mocha color scheme
+- Fantasque Sans Mono fonts
+- Themed around my terminal
+
+## Building locally
+
+To serve:
+```bash
+zola serve
+```
+
+To build:
+```bash
+zola build
+```
+
+## Structure
+
+- `content/` - all pages
+  - `blog/` - blog posts
+  - `licenses/` - ARPL license page
+  - `pgp/` - PGP key page
+  - `projects/` - projects section
+- `static/` - static resources
+  - `assets/` - images, etc.
+  - `fonts/` - font files
+  - `style.css` - main stylesheet
+- `templates/` - Zola templates
+  - `404.html` - sassy 404 page
+  - `base.html` - base template
+  - `blog-page.html` - individual blog post
+  - `blog.html` - blog index
+  - `index.html` - homepage
+  - `page.html` - generic page template
+  - `project.html` - projects page
+
+## License 
+
+MPL-2.0 - see LICENSE for details
 
-My personal website (version 3).
-https://v3.arslaancodes.com
-- 
cgit v1.2.3