some readme

1 files changed, 65 insertions, 1 deletions

diff --git a/README.org b/README.org
index c503659..771363f 100644
--- a/README.org
+++ b/README.org
@@ -2,7 +2,7 @@
 
 ** Installation
 
-First install [clpm](https://www.clpm.dev/).  
+First install [[https://www.clpm.dev/][clpm]].
 
 Next, cd into the directory where this repository is kept, and do:
 
@@ -18,6 +18,70 @@ If everything worked, you'll have a binary called =ol= in the
 directory. Move this into your path. I typically place things like
 this in =~/.local/bin/=.
      
+*** Troubleshooting
+
+CLPM is still in development, and sometimes the command line tool
+doesn't work as well as it should (IDK why).  If you encountered
+errors in the above process, try installing from a SLIME session like
+so:
+
+#+begin_src lisp
+
+(clmp-client:install 
+  :context    #p"/path/to/whereever/you/put/oneliners.cli/clpmfile")
+
+;; this will ask you to install some things from the debugger. Usually
+;; picking restart number 0 will download and install the missing
+;; dependencies.  
+
+(clpm-client:activate-context 
+   #p"/path/to/whereever/you/put/oneliners.cli/clpmfile"
+   :activate-asdf-integration t)
+
+;; test that you can load the system 
+
+(asdf:load-system "oneliners.cli") 
+
+#+end_src
+
+If you are able to load the ="oneliners.cli"= system in the repl, you
+should be able to build it.  
+
+Now try again:
+
+:  clpm bundle exec -- sbcl --load build-app.lisp 
+
+
+** Configuration 
+
+The first time you try to run the =ol= command to do anything other
+than printing the help menu, you will be prompted to configure it. 
+
+At present there are only two configuration options handled here: a
+host and a shell. The host is where the =ol= command will make
+requests. The shell is the shell environment where you want to run
+oneliners.  Host defaults to https://api.oneliners.wiki and shell
+defaults to =bash=.
+
+If you just want to lookup and run oneliners from the default wiki,
+you just need to accept the defaults offered by the configuration
+prompts.
+
+If you are self-hosting a oneliners wiki server, you'll need to enter
+the address of that server when prompted for a host.  
+
+E.g. if you are running a server locally on port 8080, you'd enter
+=http://127.0.0.1:8080= 
+
+*** For contributors 
+
+If you want to contribute new oneliners, flag oneliners as fishy, or
+if you want to edit oneliners, then you'll need a contributor
+account. At present accounts are invite only. If you find yourself
+with an invite, then checkout the =invites== help topic.
+
+:  ol --help=invites 
+
 
 ** Author