commit 2a3a83010562a967a3b62029b4321184ce346254 Chris Bracken <chris@bracken.jp> 2020-05-19 23:51:21 -0700 Minor wording/punctuation improvements in README Removed leading spaces before colons in the body text, since they're typically not used in English. I left them in the lists of options and arguments since, to be honest, it's a bit more legible that way. Ref: https://en.wikipedia.org/wiki/Colon_(punctuation)#Spacing
README.md | 38 +++++++++++++++++++------------------- 1 file changed, 19 insertions(+), 19 deletions(-)
diff --git a/README.md b/README.md index e9780a8..fac5ff8 100644 --- a/README.md +++ b/README.md @@ -5,16 +5,16 @@ Clic (Common LISP Interactive Client) is a terminal based gopher client. The name is a bad pun, **clic** is the sound of a mouse click but the software is keyboard driven... -Clic supports TLS connection by first trying to speak TLS to the remote -server, if it doesn't work it fallback to plaintext. The status prompt +Clic supports TLS connections by first trying to speak TLS to the remote +server, if it doesn't work, it falls back to plaintext. The status prompt will show either "**TLS**" or "UNSECURE" depending on how the communication -has been negociated. +has been negotiated. Requirements ============ -clic requires a few dependencies : +clic requires a few dependencies: + ANSI compatible terminal emulator + ecl common lisp interpreter @@ -28,7 +28,7 @@ How to build `clic` binary must be compiled. To compile it with **ecl**, it's really easy type the following -command : +command: make @@ -43,8 +43,8 @@ How to use clic By default *clic* will load the page **gopherproject/1/** with a number on the left of each link. Please type the number of a link to -follow it. If it's a text, the $PAGER program will be called to show -it, if it's a binary file (types g,I and 9) it will be downloaded into +follow it. If it's a text, the $PAGER program will be called to show it, +if it's a binary file (types g,I and 9) it will be downloaded into `/tmp/` and then `xdg-open` will be called on the filename. @@ -61,7 +61,7 @@ Keyboard bindings + d : display the raw response In addition to the previous keybinding, a different layout coexists, -permitting to use clic with the numpad with only one hand : +permitting clic to be used with the numpad with only one hand: + "a number" : follow the link "number + / : previous page @@ -74,17 +74,17 @@ Command line usage clic [-t] [-k] [url|file] -If you start clic with -t parameter, then menus will be displayed in -one operation, instead of asking to display next page once it reach +If you start clic with the -t option, menus will be displayed in a +single operation, instead of asking to display next page once it reaches your terminal size. -If you start clic with -k parameter, then kiosk mode is enabled, which -mean it won't call any external program or save any data on the -disk. Texts (type 0) will be shown as-this in the output. It only -allow to use texts, menus and searches. +If you start clic with the -k option, then kiosk mode is enabled, in +which case it won't call any external program or save any data to disk. +Texts (type 0) will be shown as-is in the output. It only allows the use +of texts, menus and searches. If you pass a gopher url to clic (gopher:// isn't mandatory for the -url), the behavor will change depending on two parameters : +url), the behavior will be determined by two parameters: 1. is the output a pipe/redirection ? 2. is the url type a menu ? (types 1 or 7) @@ -92,9 +92,9 @@ url), the behavor will change depending on two parameters : If the output is a pipe or a redirection, clic will send the raw data to stdout (text for type 0 and binary for others types) -If the output is the terminal, clic will download the file in /tmp/ -folder and then call $PAGER if the type is 0 (text) or xdg-open for -others types. +If the output is the terminal, clic will download the file in the +`/tmp/` folder, then call $PAGER if the type is 0 (text) or xdg-open +for others types. If the url is a type 0 or 7 and the output is a terminal, it will open clic and stay in interactive mode. @@ -102,6 +102,6 @@ clic and stay in interactive mode. Clic can open a local file respecting the gopher menu protocol, this can be used to create a bookmark file and load it locally without a gopher server. In order to proceed, you need to pass the file path as -a parameter beginning with file://, like the following example : +a parameter beginning with file://, as in the following example: clic file://path/to/my_file.txt