From 0b6a1618cdc1479be7dfb185422178f4350b7345 Mon Sep 17 00:00:00 2001
From: alxnorden
Date: Mon, 24 Feb 2020 11:22:19 +0100
Subject: [PATCH 1/2] update README.md - quicklisp instructions
We're on Quicklisp!
I've added a quickstart with basic install and ed usage, please review.
---
README.md | 51 ++++++++++++++++++++++++++++++++++++++-------------
1 file changed, 38 insertions(+), 13 deletions(-)
diff --git a/README.md b/README.md
index d3fc7cf..02d21fa 100644
--- a/README.md
+++ b/README.md
@@ -13,6 +13,19 @@ This package also can be a starting point for people who are not
accustomed to Emacs or SLIME and would like to continue using their
default terminal/console editor with Common Lisp.
+## Quickinstall and start
+Install via [Quicklisp](http://www.quicklisp.org), which updates distro about once a month.
+```lisp
+(ql:quickload "magic-ed")
+```
+For simple editing from the REPL, launch your system configured EDitor
+```lisp
+(ed "file-name.lisp")
+````
+
+For the daily updates track, install via Ultralisp. You can also install manually.
+See instructions for other installation options and use below.
+
## Usage
You start it with:
@@ -27,8 +40,8 @@ will load that file and evaluate it. If file saving somehow failed, nothing
will be evaluated.
In background, *magic-ed* will try to use *(ed)* standard function and
-will try to obey implementation specific features. For example, on
-SBCL if *sb-ext:\*ed-functions** was set, *magic-ed* will not use
+will try to obey implementation specific features. For example, in
+SBCL, if *sb-ext:\*ed-functions** was set, *magic-ed* will not use
environment value.
If you do not want edited file to be evaluated, you use **:eval** parameter
@@ -46,23 +59,35 @@ be returned as escaped string, use **:output** parameter (accepts only
(setf content (magic-ed:magic-ed "/tmp/test.lisp" :output :string))
```
-## Installation
+## Installation options
First setup *EDITOR* environment variable to point to your favorite
-editor (on *nix, often nano or vi, distribution dependent config and change) and
-download magic-ed code (official release or clone it from this repository) and run:
+editor (on *nix, often nano or vi, distribution dependent config and change)
+and download magic-ed code via Quicklisp, Ultralisp, or manually
+(clone it from this repository).
-```lisp
-(asdf:load-system :magic-ed)
-```
-### Install with Ultralisp Via Quicklisp
+### Ultralisp via Quicklisp
Magic-ed is [available](https://ultralisp.org/projects/sanel/magic-ed) on Ultralisp.
+Ultralisp updates more often than Quicklisp, so this install is recommended.
+
Install [Quicklisp](http://www.quicklisp.org), install [Ultralisp](https://ultralisp.org/).
Then use the standard Quicklisp installation method.
-### Manual download and installation with Quicklisp
-If you have [Quicklisp](http://www.quicklisp.org) only:
+### Manual download or via Quicklisp
+
+As given above in the Quickstart, do
+
+```lisp
+(ql:quickload "magic-ed")
+```
+### ASDF
+
+```lisp
+(asdf:load-system :magic-ed)
+```
+Manual install:
+
Download or git clone magic-ed to Your quicklisp directory manually
( usually ~/quicklisp/local-projects/ )
@@ -96,5 +121,5 @@ In SBCL: edit Your ~/.sbclrc and add to the end, after ql lines:
The magic-ed code was tested on SBCL, ECL, Clozure CL and CMUCL.
## License
-Copyright (c) 2013-2019 Sanel Zukan. You can use this code whatever you
-like.
+Copyright (c) 2013-2020 Sanel Zukan. You can use this code however you
+like, in accordance with the MIT license.
From dd5bef17e8850ba87ab682593c24c7657f9bad34 Mon Sep 17 00:00:00 2001
From: alxnorden
Date: Mon, 24 Feb 2020 11:35:15 +0100
Subject: [PATCH 2/2] Update README.md
Added the QL update db command
---
README.md | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
index 02d21fa..a9c4b63 100644
--- a/README.md
+++ b/README.md
@@ -76,9 +76,10 @@ Then use the standard Quicklisp installation method.
### Manual download or via Quicklisp
-As given above in the Quickstart, do
+Do an update of the QL database and install:
```lisp
+(ql:update-dist "quicklisp")
(ql:quickload "magic-ed")
```
### ASDF