aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorwinter2025-02-16 21:17:09 +0000
committerwinter2025-02-16 21:17:09 +0000
commit00fc10a04f90e761edf2b1ddca04f0ec6bb030b5 (patch)
tree1a50f27b25bac40cc78af212b9bfc1a0fdfc62d1
parent31b7ca2056dad13b3d9b059f7e552b1a576c5214 (diff)
update readme: it's actually usable now :3
-rw-r--r--README.md14
1 files changed, 11 insertions, 3 deletions
diff --git a/README.md b/README.md
index b80f140..9a8185f 100644
--- a/README.md
+++ b/README.md
@@ -5,9 +5,6 @@ protocol.
## running the server
-**it is not in a usable state yet!** nothing useful will happen by running it,
-unless you're working on it.
-
you should have:
* php >= 8.3 with the `pdo_pgsql` and `sockets` extensions
@@ -28,3 +25,14 @@ the basic steps for setup are:
you can poke around with `bin/shell` which will launch the interactive php
shell and initialise all the composer autoloads and so on
+
+whenever you want to update to the latest version (from git) you should:
+
+1. run `git pull`
+2. if there were any changes to composer.json/composer.lock, run
+ `composer install` (if you're not sure it can't hurt to run it just in case)
+3. run `bin/migrate`
+4. hope it works :3
+
+if it looks messed up in your web browser after updating, you should be able
+to fix it by force reloading the page once