Add a little documentation - clic - Clic is an command line interactive client for gopher written in Common LISP
HTML git clone git://bitreich.org/clic/ git://enlrupgkhuxnvlhsf6lc3fziv5h2hhfrinws65d7roiv6bfj7d652fid.onion/clic/
DIR Log
DIR Files
DIR Refs
DIR Tags
DIR README
DIR LICENSE
---
DIR commit b9e1ff0dd2d9983d2cfbf28f805ef0603076bb9d
DIR parent 500614e4448379ce916b917276dfd99db907fc59
HTML Author: Solene Rapenne <solene@perso.pw>
Date: Fri, 3 Nov 2017 14:07:31 +0000
Add a little documentation
Diffstat:
A README.md | 51 +++++++++++++++++++++++++++++++
1 file changed, 51 insertions(+), 0 deletions(-)
---
DIR diff --git a/README.md b/README.md
@@ -0,0 +1,51 @@
+# Introduction
+
+Clic (Common LISP Interactive Client) is a gopher client.
+
+It currently works with **ecl** and **sbcl** compilers. Just load it
+with sbcl like this
+
+ sbcl --load clic.lisp
+
+or with ecl
+
+ ecl -load clic.lisp**.
+
+
+# Make a binary
+
+To create an binary you can load **make-binary.lisp** with ecl.
+
+ ecl -load make-binary.lisp
+
+You will get a binary named *clic*.
+
+I don't provide a way to generate a binary with sbcl because it
+creates binaries larger than 10 Mb.
+
+# Use it
+
+By default *clic* will load the page **bitreich.org/1/** and make you
+in "shell mode". Just type the number of a link to follow the link. If
+you have seen a long text or multiple texts and you don't know what
+links you can use, type **p** to show again the latest page with the
+links. You can exit shell mode with **x**.
+
+## Shell mode
+
+- "a number" : follow the link "number"
+- p : display the latest page with links you have seen
+- x : quit shell mode
+
+## Non shell-mode ##
+
+### Fetch a page
+
+- use `(getpage "hostname" 70 "/")` to fetch the root of a gopherspace
+- one can use `(getpage "hostname" 70 "/sometext.txt" 0)` to tell it's a type 0
+- using *getpage* you will have numbers on links, use (g numer) to request the link
+
+## Variables
+
+There is a hash-table named *links* with links available.
+