From 3a9c7b6cb57fdf0b197dedae39275de5ada598da Mon Sep 17 00:00:00 2001 From: Colin Okay Date: Sat, 12 Nov 2022 07:32:36 -0600 Subject: Add: HACKING instructions --- HACKING | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 HACKING (limited to 'HACKING') diff --git a/HACKING b/HACKING new file mode 100644 index 0000000..cf244f3 --- /dev/null +++ b/HACKING @@ -0,0 +1,30 @@ + +To hack on Vampire locally, here's what I'd do. + +1. copy the vampire static directory to your home dir, calling it vampire-static: + + cp -r /path/to/vampire.git/static ~/vampire-static + +2. Fire up SLIME and ensure that you can load vampire in quicklisp + + > (pushnew #P"/path/to/vampire.git/" ql:*local-project-directories*) + > (pushnew #P"/path/to/derrida.git/" ql:*local-project-directories*) + > (ql:quickload :vampire) + +3. Run (vampire::hacking-start), which will + - create a bknr.datastore in ~/vampire-store + - start the service + - open a browser tab and give it focus + +The first time you start up vampire, or anytime after deleting +~/vampire-store/, you'll need to make a new invite so you can make an +account for your local use: + +4. Make an invite to use: + + > (in-package :vampire) + > (with-transaction () + > (key (make-invite nil 1))) ;; one time anonymous invite. + +That should print an invite code into the REPL. Use that code in the +web interface for making a new account. -- cgit v1.2.3