From 32310d910b8721f46c96cfb3709ca2d13da7b066 Mon Sep 17 00:00:00 2001 From: colin Date: Sun, 1 Jan 2023 09:01:10 -0800 Subject: Docs: Changed Hacking and Install docs --- HACKING.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 HACKING.md (limited to 'HACKING.md') diff --git a/HACKING.md b/HACKING.md new file mode 100644 index 0000000..423ae5d --- /dev/null +++ b/HACKING.md @@ -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) + (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