From b6ac33f73e28925e814ff76bbbac12fcb5d7d4ff Mon Sep 17 00:00:00 2001
From: Annika Backstrom <annika@sixohthree.com>
Date: Sat, 25 May 2024 16:00:47 +0100
Subject: [PATCH] readme: development instructions

---
 README.md | 39 ++++++++++++++++++++++++++++++++++++++-
 1 file changed, 38 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index dac2d09..3139bca 100644
--- a/README.md
+++ b/README.md
@@ -15,9 +15,46 @@ A little project because I haven't made anything new in a while, I would like to
 * [ ] Tag permalink
 * [ ] Multi-user support
 
+## Developing
+
+Get the code:
+
+```
+git clone https://git.abackstrom.com/annika/urlsnail.git
+cd urlsnail
+```
+
+Set up the Laravel `.env` file and SQLite database:
+
+```
+composer install
+cp .env.example .env
+php artisan key:generate
+php artisan migrate
+```
+
+Build the CSS with Vite:
+
+```
+npm install
+npm run build       # `npm run dev` if you want css live reloading
+```
+
+Start the web server:
+
+```
+php artisan serve
+```
+
+### Laravel Herd
+
+If you have [Laravel Herd](https://herd.laravel.com/) installed, you can clone the repository to one of your Herd
+paths (e.g. `~/Herd`) and view the site at [http://urlsnail.test](http://urlsnail.test), no need
+to run `php artisan serve`.
+
 ## License
 
-This project is copyright ©2024 Annika Backstrom.
+This project is Copyright ©2024 Annika Backstrom.
 
 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU Affero General Public License as