[elpa] externals/sketch-mode 887f68a: Update documentation (and version number for ELPA deploy)

[ELPA Syncer]

branch: externals/sketch-mode
commit 887f68ac1800c0bd3062ecabdfc4e1abe42c9480
Author: Daniel Nicolai <dalanicolai@gmail.com>
Commit: Daniel Nicolai <dalanicolai@gmail.com>

    Update documentation (and version number for ELPA deploy)
---
 README.org     |  38 ++++++++++++--------
 sketch-mode.el | 108 ++++++++++++++++++++++++++++-----------------------------
 2 files changed, 78 insertions(+), 68 deletions(-)

diff --git a/README.org b/README.org
index 587d48f..2506313 100644
--- a/README.org
+++ b/README.org
@@ -5,11 +5,11 @@
   The initial version with the transient can be found in the 
'transient-version'
   branch. This version introduced a toolbar which made the transient
   unnecessary. Also removing the transient frees up drawing space. It has been
-  replaced by a hydra which can togglable. Also an earlier version showed the
+  replaced by a hydra which is togglable. Also an earlier version showed the
   mouse coordinate position in the mode-line. However, this functionality
-  hinders the 'interactive' drawing (which might could be considered an emacs
-  bug). Anyway, you can toggle showing the coordinates by pressing =t c= (maybe
-  it works more fluently on your system).
+  hinders the 'interactive' drawing (which might be due to an emacs 'bug').
+  Anyway, you can toggle showing the coordinates by pressing =t c= (maybe it
+  works more fluently on your system).
 
 * Preliminary comment
   This is a new package that is still in development. It has been on ELPA-devel
@@ -34,12 +34,12 @@
   
 ** Included features
    - mnemonic shortcuts + hydra and (alternatively) a toolbar
-   - quickly insert image definition into new type (image) org-block (no
-     external file required)
+   - quickly insert image definition into new type (image) org-block with the
+     image rendered as overlay (no external file required)
    - snap to grid (on minor-grid, however major and minor grid are fully
      configurable)
    - draw text
-   - crop finale image
+   - crop final image
    - set stroke, fill, width etc.
    - show dom (lisp) in other window
    - draw angle arcs (between lines, available soon, I hope. See
@@ -64,17 +64,23 @@
   The =sketch-mode.el= file starts with listing TODO items describing features
   that are missing from the package.
 
-  [[./happy-sketching.gif]] *THIS SCREENCAST STILL SHOWS THE SKETCH-MODE 
TRANSIENT
-VERSION. AN UPDATED SCREENSHOT WILL HOPEFULLY ARRIVE TOMORROW*
+  [[./happy-sketching.gif]]
+  *THIS SCREENCAST STILL SHOWS THE SKETCH-MODE TRANSIENT VERSION. AN UPDATED
+  SCREENSHOT WILL HOPEFULLY ARRIVE TOMORROW*
 
 * Installation
-  When installing the package it probably still shows some warnings, you can
-  safely ignore them.
+  The package is available from 
[[https://elpa.gnu.org/packages/sketch-mode.html][GNU ELPA]], so it can simply 
get installed as
+  usual. However, the publishing 'cycle' on ELPA is somewhat slow, while
+  development on this package is 'less slow'. So you might prefer to install
+  from github directly as follows:
   
   Either =git clone= the package and load =sketch-mode.el= using =load file=
   either manually or from =.emacs.d=.
 
-  Alternatively you could use a [[quelpa][https://github.com/quelpa/quelpa]] 
with the
+  When installing the package it probably still shows some warnings, you can
+  safely ignore them.
+  
+  Alternatively you could use [[quelpa][https://github.com/quelpa/quelpa]] 
with the
   following recipe:
  #+begin_src emacs-lisp :tangle yes
    (quelpa '(sketch-mode :repo "dalanicolai/sketch-mode" :fetcher github))
@@ -86,7 +92,11 @@ VERSION. AN UPDATED SCREENSHOT WILL HOPEFULLY ARRIVE 
TOMORROW*
 #+end_src  
 
 ** Spacemacs
-  Add the following lines to =dotspacemacs-additional-packages=
+  The package is available from 
[[https://elpa.gnu.org/packages/sketch-mode.html][GNU ELPA]], so it can simply 
get installed by
+  simply adding =sketch-mode= to =dotspacemacs-additional-packages=. However,
+  the publishing 'cycle' on ELPA is somewhat slow, while development on this
+  package is 'less slow'. So you might prefer to install from github directly 
as
+  follows:
   
 #+begin_src emacs-lisp :tangle yes
   (sketch-mode :location (recipe
@@ -147,7 +157,7 @@ VERSION. AN UPDATED SCREENSHOT WILL HOPEFULLY ARRIVE 
TOMORROW*
   it, then I would be very happy with any donation (of course that would also
   enable me to work on your feature requests). As soon as I have the
   opportunity/possibility to find a stable job, I will happily suggest you to
-  transfer or donate to other projects/charity.
+  transfer or donate to other projects/charity instead.
 
   If you would like to =boost= development of any of my projects, then
   contribute (code or documentation), or consider more sustainable financial
diff --git a/sketch-mode.el b/sketch-mode.el
index be73b60..72183e0 100644
--- a/sketch-mode.el
+++ b/sketch-mode.el
@@ -4,7 +4,7 @@
 
 ;; Author: D.L. Nicolai <dalanicolai@gmail.com>
 ;; Created: 17 Jul 2021
-;; Version: 1.0
+;; Version: 1.0.1
 
 ;; Keywords: multimedia
 ;; URL: https://github.com/dalanicolai/sketch-mode
@@ -650,7 +650,7 @@ VEC should be a cons or a list containing only number 
elements."
                                                 points))))
          (label (unless (memq sketch-action '(move translate))
                   (sketch-create-label sketch-action))))
-    (pcase  sketch-action
+    (pcase sketch-action
       ('text (hydra-sketch/nil)
              (let ((text (read-string "Enter text: ")))
                (apply #'svg-text
@@ -712,58 +712,58 @@ VEC should be a cons or a list containing only number 
elements."
                         (sketch-update-lisp-window node 
sketch-lisp-buffer-name))))))
 
 
-                   ((or polyline polygon)
-                    (while (not (eq (car event) 'double-mouse-1))
-                      (setq event (read-event))
-                      (let* ((end (event-start event))
-                             (end-coords (if sketch-snap-to-grid
-                                             (sketch--snap-to-grid 
(posn-object-x-y end) sketch-minor-grid-param)
-                                           (posn-object-x-y end))))
-                        (let (message-log-max)
-                          (message "Press double click finish by inserting a 
final node"))
-                        (setf (dom-attr node 'points) (mapconcat (lambda (pair)
-                                                                   (format "%s 
%s" (car pair) (cdr pair)))
-                                                                 (reverse
-                                                                  (if (eq (car 
event) 'down-mouse-1)
-                                                                      (push 
end-coords points)
-                                                                    (cons 
end-coords points)))
-                                                                 ", "))
-                        (sketch-redraw nil nil t)
-                        (setq sketch-cursor-position (format "(%s, %s)"
-                                                             (car end-coords)
-                                                             (cdr end-coords)))
-                        (sketch-maybe-update-modeline)))
-                    (let* ((end (event-end event))
-                           (end-coords (if sketch-snap-to-grid
-                                           (sketch--snap-to-grid 
(posn-object-x-y end) sketch-minor-grid-param)
-                                         (posn-object-x-y end))))
-                      (setf (dom-attr node 'points) (mapconcat (lambda (pair)
-                                                                 (format "%s 
%s" (car pair) (cdr pair)))
-                                                               (reverse
-                                                                (if (eq (car 
event) 'down-mouse-1)
-                                                                    (push 
end-coords points)
-                                                                  (cons 
end-coords points)))
-                                                               ", "))))
-
-
-                   ('freehand
-                    (while (not (memq (car event) '(mouse-1 drag-mouse-1)))
-                      (setq event (read-event))
-                      (let* ((end (if (eq (car event) 'drag-mouse-1)
-                                      (event-end event)
-                                    (event-start event)))
-                             (end-coords (if sketch-snap-to-grid
-                                             (sketch--snap-to-grid 
(posn-object-x-y end) sketch-minor-grid-param)
-                                           (posn-object-x-y end))))
-                        (setf (dom-attr node 'points) (mapconcat (lambda (pair)
-                                                                   (format "%s 
%s" (car pair) (cdr pair)))
-                                                                 (reverse 
(cl-pushnew end-coords points))
-                                                                 ", "))
-                        (sketch-redraw nil nil t)
-                        (setq sketch-cursor-position (format "(%s, %s)"
-                                                             (car end-coords)
-                                                             (cdr end-coords)))
-                        (sketch-maybe-update-modeline)))))))))
+               ((or polyline polygon)
+                (while (not (eq (car event) 'double-mouse-1))
+                  (setq event (read-event))
+                  (let* ((end (event-start event))
+                         (end-coords (if sketch-snap-to-grid
+                                         (sketch--snap-to-grid 
(posn-object-x-y end) sketch-minor-grid-param)
+                                       (posn-object-x-y end))))
+                    (let (message-log-max)
+                      (message "Press double click to finish by inserting a 
final node"))
+                    (setf (dom-attr node 'points) (mapconcat (lambda (pair)
+                                                               (format "%s %s" 
(car pair) (cdr pair)))
+                                                             (reverse
+                                                              (if (eq (car 
event) 'down-mouse-1)
+                                                                  (push 
end-coords points)
+                                                                (cons 
end-coords points)))
+                                                             ", "))
+                    (sketch-redraw nil nil t)
+                    (setq sketch-cursor-position (format "(%s, %s)"
+                                                         (car end-coords)
+                                                         (cdr end-coords)))
+                    (sketch-maybe-update-modeline)))
+                (let* ((end (event-end event))
+                       (end-coords (if sketch-snap-to-grid
+                                       (sketch--snap-to-grid (posn-object-x-y 
end) sketch-minor-grid-param)
+                                     (posn-object-x-y end))))
+                  (setf (dom-attr node 'points) (mapconcat (lambda (pair)
+                                                             (format "%s %s" 
(car pair) (cdr pair)))
+                                                           (reverse
+                                                            (if (eq (car 
event) 'down-mouse-1)
+                                                                (push 
end-coords points)
+                                                              (cons end-coords 
points)))
+                                                           ", "))))
+
+
+               ('freehand
+                (while (not (memq (car event) '(mouse-1 drag-mouse-1)))
+                  (setq event (read-event))
+                  (let* ((end (if (eq (car event) 'drag-mouse-1)
+                                  (event-end event)
+                                (event-start event)))
+                         (end-coords (if sketch-snap-to-grid
+                                         (sketch--snap-to-grid 
(posn-object-x-y end) sketch-minor-grid-param)
+                                       (posn-object-x-y end))))
+                    (setf (dom-attr node 'points) (mapconcat (lambda (pair)
+                                                               (format "%s %s" 
(car pair) (cdr pair)))
+                                                             (reverse 
(cl-pushnew end-coords points))
+                                                             ", "))
+                    (sketch-redraw nil nil t)
+                    (setq sketch-cursor-position (format "(%s, %s)"
+                                                         (car end-coords)
+                                                         (cdr end-coords)))
+                    (sketch-maybe-update-modeline)))))))))
     (when-let (buf (get-buffer "*sketch-root*"))
       (sketch-update-lisp-window sketch-root buf))
     (sketch-redraw)))