From dc04d1f1aadef514c9b5b362b499654c1e9b6ec2 Mon Sep 17 00:00:00 2001 From: Colin Okay Date: Sun, 7 Aug 2022 17:01:25 -0500 Subject: updated readme --- README.org | 24 ++++++++++++++++++++---- 1 file changed, 20 insertions(+), 4 deletions(-) diff --git a/README.org b/README.org index 03e586e..60f638f 100644 --- a/README.org +++ b/README.org @@ -1,6 +1,6 @@ * Oneliners.Api -** Installation +** Building First, ensure that you have quicklisp installed. @@ -8,16 +8,32 @@ Next, fetch dependencies that are not in quicklisp. #+begin_example mkdir oneliner-build && cd oneliner-build -git clone https://cicadas.surf/cgit/oneliners/oneliners.api.git -git clone https://cicadas.surf/cgit/colin/lazybones.git -git clone https://cicadas.surf/cgit/colin/lambda-riffs.git +git clone https://cicadas.surf/cgit/oneliners/oneliners.api.git oneliners.api +git clone https://cicadas.surf/cgit/colin/lazybones.git lazybones +git clone https://cicadas.surf/cgit/colin/lambda-riffs.git lambda-riffs #+end_example The build script expects to be run from inside the oneliners.api.git +#+begin_example + +cd oneliners.api +sbcl --load build.lisp + +#+end_example + +This should put an executable file olwiki-server in the durrent directory. ** Usage +#+begin_example + +olwiki-server --config /path/to/a/config/file + +#+end_example + +See the example config file for what to pass to --config + ** Copyright Copyright (c) 2022 Colin Okay (colin@cicadas.surf) -- cgit v1.2.3