summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md28
1 files changed, 21 insertions, 7 deletions
diff --git a/README.md b/README.md
index 97cc897..0ba218a 100644
--- a/README.md
+++ b/README.md
@@ -3,23 +3,37 @@ This contains the entirety of https://matthewkosarek.xyz, which is my personal w
If you are on Github, this is a mirror of: https://git.matthewkosarek.xyz/matthew_kosarek_xyz/
+## Prerequisites
+- Node.js (for Astro)
+- Emacs (for publishing org-mode posts)
+- Meson + Emscripten (for building the WebAssembly themes)
## Building
-### Themes
-See the [themes subproject](./themes/README.md) for more information on how to build the themes.
+### Everything
+```sh
+make build
+```
+This runs the posts, themes, and Astro build in sequence. Output goes to `dist/`.
-### Posts
+### Themes only
+See the [themes subproject](./themes/README.md) for more information on how to build the themes, or run:
```sh
-./publish.sh
+make copy-themes
```
-## Running
+## Development
```sh
-./run_dev.sh
-firefox localhost:8080
+npm install # first time only
+make dev
+# visit http://localhost:4321
```
+`make dev` regenerates post fragments then starts the Astro dev server with hot reload.
+## Adding a Post
+1. Create a new `.org` file in `_posts/` with `#+TITLE:`, `#+DATE:`, and `#+filetags:` headers
+2. Run `make posts` to generate the HTML fragment
+3. The post will appear at `/posts/<filename-without-extension>`
## Publishing
```sh