diff options
| author | Colin Okay <colin@cicadas.surf> | 2022-08-05 15:32:44 -0500 |
|---|---|---|
| committer | Colin Okay <colin@cicadas.surf> | 2022-08-05 15:32:44 -0500 |
| commit | 814620c8c17de04bacc962492d2d62bb5da4cf48 (patch) | |
| tree | d845c7d5500b6372bbd3cd24b810a00267614cb9 /README.org | |
| parent | 13d819c7be13e815907a526003213a0dca5630ce (diff) | |
[documentation] updated the readme
Diffstat (limited to 'README.org')
| -rw-r--r-- | README.org | 73 |
1 files changed, 10 insertions, 63 deletions
@@ -2,56 +2,21 @@ ** Installation -First install [[https://www.clpm.dev/][clpm]]. +For now you need to build it from source. -Next, cd into the directory where this repository is kept, and do: +First clone it -#+begin_src bash +: git clone https://cicadas.surf/cgit/oneliners/oneliners.cli.git oneliners.cli -rm clpmfile.lock # just for good measure -clpm bundle install # say yes to questions -clpm bundle exec -- sbcl --load build-app.lisp +then =cd= into the =oneliners.cli= directory and type make app -#+end_src - -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 +: cd oneliners.cli +: make app +If the build was successful, the executable will be in =bin/ol= +*!!! ONLY TESTED WITH SBCL !!!* + ** Configuration The first time you try to run the =ol= command to do anything other @@ -73,24 +38,6 @@ 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 - -+ Colin Okay (okay@toyful.space) - -** Copyright - -Copyright (c) 2022 Colin Okay (okay@toyful.space) - -** License +* License Licensed under the AGPLv3 License. |