aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorColin Okay <okay@toyful.space>2022-08-07 17:01:25 -0500
committerColin Okay <okay@toyful.space>2022-08-07 17:01:25 -0500
commitdc04d1f1aadef514c9b5b362b499654c1e9b6ec2 (patch)
tree9cb2bdcb0962d7b00c3a2ec48b80dd4e18fcc64e
parent5a4fc77c0ffdc1ceacb0968d5a59ee1726bcd8e9 (diff)
updated readme
-rw-r--r--README.org24
1 files 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)