Commit 8d949f10 authored by Eric Timmons's avatar Eric Timmons
Browse files

Add client documentation.

parent a79d9073
......@@ -78,50 +78,48 @@ is still a little rough around the edges and it may accidentally eat your files.
+ sqlite :: Needed if compiling from source or using the dynamically linked
version.
To install CLPM in binary form, download the appropriate file from
[[https://common-lisp.net/project/clpm/downloads/][https://common-lisp.net/project/clpm/downloads/]]. It is highly recommended that
you use the static variants. Each release of CLPM consists of the following
files:
+ =clpm-$VERSION-x86_64-linux-gnu-dynamic= :: CLPM compiled for 64bit
Linux. Dynamically links against glibc (GNU's libc) and all supporting
libraries.
+ =clpm-$VERSION-x86_64-linux-gnu-static= :: CLPM compiled for 64bit
Linux. Dynamically links against glibc (GNU's libc) and statically linked
against all supporting libraries.
+ =clpm-$VERSION-x86_64-linux-musl-dynamic= :: CLPM compiled for 64bit
Linux. Dynamically links against musl libc and all supporting libraries.
+ =clpm-$VERSION-x86_64-linux-musl-static= :: CLPM compiled for 64bit
Linux. Dynamically links against musl libc and statically linked against all
supporting libraries.
+ =clpm-$VERSION-x86_64-windows-dynamic= :: CLPM compiled for 64bit
Windows. Dynamically links against all supporting libraries.
+ =clpm-$VERSION-x86_64-windows-static= :: CLPM compiled for 64bit
Windows. Statically linked against all supporting libraries.
+ =clpm-$VERSION.DIGESTS= :: Text file containing the SHA512 sums for every
previously mentioned file.
+ =clpm-$VERSION.DIGESTS.asc= :: Same as =clpm-$VERSION.DIGESTS=, but signed
with GPG key =0x10327DE761AB977333B1AD7629932AC49F3044CE=.
After downloading the binary and validating the SHA512 sum, make sure the
file is executable and save it as =clpm= somewhere on your PATH.
The next easiest way to install CLPM is to install SBCL, clone the CLPM
sources (including the git submodules!), and link the [[file:scripts/clpm-live][clpm-live]] script as
=clpm= somewhere on your PATH. Alternatively, you can build a dynamically or
statically linked executable by running one of the following:
#+begin_src shell
sbcl --script scripts/clpm-build-dynamic-sbcl
sbcl --script scripts/clpm-build-static-sbcl
#+end_src
After ensuring =clpm= is on your path you can install the client library and
(optionally) add it to your ASDF search path by running:
#+begin_src shell
clpm client
#+end_src
After installing CLPM, it is recommended you also install the CLPM client (see
[[file:doc/client.org][client.org]]), but it is not needed for the quickstart.
** Prebuilt binaries
To install CLPM in binary form, download the appropriate file from
[[https://common-lisp.net/project/clpm/downloads/][https://common-lisp.net/project/clpm/downloads/]]. It is highly recommended that
you use the static variants. Each release of CLPM consists of the following
files:
+ =clpm-$VERSION-x86_64-linux-gnu-dynamic= :: CLPM compiled for 64bit
Linux. Dynamically links against glibc (GNU's libc) and all supporting
libraries.
+ =clpm-$VERSION-x86_64-linux-gnu-static= :: CLPM compiled for 64bit
Linux. Dynamically links against glibc (GNU's libc) and statically linked
against all supporting libraries.
+ =clpm-$VERSION-x86_64-linux-musl-dynamic= :: CLPM compiled for 64bit
Linux. Dynamically links against musl libc and all supporting libraries.
+ =clpm-$VERSION-x86_64-linux-musl-static= :: CLPM compiled for 64bit
Linux. Dynamically links against musl libc and statically linked against
all supporting libraries.
+ =clpm-$VERSION-x86_64-windows-dynamic= :: CLPM compiled for 64bit
Windows. Dynamically links against all supporting libraries.
+ =clpm-$VERSION-x86_64-windows-static= :: CLPM compiled for 64bit
Windows. Statically linked against all supporting libraries.
+ =clpm-$VERSION.DIGESTS= :: Text file containing the SHA512 sums for every
previously mentioned file.
+ =clpm-$VERSION.DIGESTS.asc= :: Same as =clpm-$VERSION.DIGESTS=, but signed
with GPG key =0x10327DE761AB977333B1AD7629932AC49F3044CE=.
After downloading the binary and validating the SHA512 sum, make sure the
file is executable and save it as =clpm= somewhere on your PATH.
** Source install
The next easiest way to install CLPM is to install SBCL, clone the CLPM
sources (including the git submodules!), and link the [[file:scripts/clpm-live][clpm-live]] script as
=clpm= somewhere on your PATH. Alternatively, you can build a dynamically or
statically linked executable by running one of the following:
#+begin_src shell
sbcl --script scripts/clpm-build-dynamic-sbcl
sbcl --script scripts/clpm-build-static-sbcl
#+end_src
* Quickstart
......
#+TITLE: CLPM Client
#+AUTHOR: CLPM Developers
#+EMAIL: clpm-devel@common-lisp.net
While CLPM can be used without the client, installing and using the client makes
Common Lisp coding a more interactive and fun experience. The CLPM Client can be
loaded into a Lisp image and integrates into ASDF to seamlessly install missing
systems a la the Quicklisp client.
* Installing
To install the CLPM Client, run the following. It will additionally prompt if
you want to add the client to your ASDF search path (highly recommended).
#+begin_src shell
clpm client
#+end_src
* Using
To use the client, just load it with ASDF and activate it.
#+begin_src common-lisp
(asdf:load-system :clpm-client)
(clpm-client:activate-clpm)
#+end_src
Now, if you attempt to ~asdf:load-system~ a missing system, a condition will
be signaled with a ~INSTALL-SYSTEM~ restart that will attempt to install the
missing system using CLPM and then load it.
If you would prefer the system to be automatically installed, you can set
~clpm-client:*clpm-system-not-found-behavior*~ to ~:install~ and it will be
silently installed if possible.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment