[elpa] externals/sketch-mode 3c8f9f1 05/38: Add documentation (prepare for publishing)

[ELPA Syncer]

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

    Add documentation (prepare for publishing)
---
 README.org     | 50 +++++++++++++++++++++++++++++++++++++++++++++++++-
 sketch-mode.el |  7 ++++---
 2 files changed, 53 insertions(+), 4 deletions(-)

diff --git a/README.org b/README.org
index a713b27..7aff01e 100644
--- a/README.org
+++ b/README.org
@@ -1,3 +1,51 @@
 #+TITLE: Sketch mode
+#+DESCRIPTION: Quickly create simple SVG sketches using the mouse
 
-* Welcome
+* Preliminary comment
+  This is a new package that is still in development. However, its main
+  functionality is very usable already. Any feedback is very welcome (probably
+  most suitable by opening an issue).
+
+  The =sketch-mode.el= start with listing
+  TODO items describing features that are missing from the package.
+  
+* Installation
+  When installing the package it probably still shows some warnings, you can
+  safely ignore them.
+  
+  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
+  following recipe:
+ #+begin_src emacs-lisp :tangle yes
+   (quelpa '(sketch-mode :repo "dalanicolai/sketch-mode" :fetcher github))
+ #+end_src 
+ then subsequently load the package with
+#+begin_src emacs-lisp :tangle yes
+  (use-package sketch-mode
+    :defer t)
+#+end_src  
+
+** Spacemacs
+  Add the following lines to =dotspacemacs-additional-packages=
+  
+#+begin_src emacs-lisp :tangle yes
+     (sketch-mode :location (recipe
+                        :fetcher github
+                        :repo "dalanicolai/sketch-mode"))
+#+end_src
+
+  Subsequently load the packages by adding the following line to 
=dotspacemacs/user-config=
+  
+ #+begin_src emacs-lisp
+  (use-package sketch-mode
+    :defer t)
+ #+end_src 
+
+* Usage
+  Start a sketch with =M-x sketch= and enter values at the prompts (or prefix
+  with =C-u= to use default values). Thanks to the =transient= package the 
usage
+  is more or less self explanatory.
+
+  Create your sketch and then save the file by pressing =S=.
diff --git a/sketch-mode.el b/sketch-mode.el
index 7d037e2..250f78e 100644
--- a/sketch-mode.el
+++ b/sketch-mode.el
@@ -203,7 +203,7 @@ values"
                (call-interactively 'sketch-transient))
       (let ((width (if arg (car sketch-default-image-size) (read-number "Enter 
width: ") ))
             (height (if arg 600 (read-number "Enter height: "))))
-        (switch-to-buffer (get-buffer-create "*sketch"))
+        (switch-to-buffer (get-buffer-create "*sketch*"))
         (defvar-local grid-param 25)
         (setq grid-param (if arg 25 (read-number "Enter grid parameter (enter 
0 for no grid): ")))
         (sketch--create-canvas width height grid-param)))))
@@ -388,10 +388,11 @@ values"
                              (transient-arg-value "--fill-color=" args)
                              :marker-end (if args (pcase (transient-arg-value 
"--marker=" args)
                                                     ("arrow" "url(#arrow)")
-                                                    ("point" "url(#point)"))
+                                                    ("point" "url(#point)")
+                                                    (_ "none"))
                                            (if sketch-include-end-marker
                                                "url(#arrow)"
-                                             "none")              (_ "none"))))
+                                             "none"))))
          (command-and-coords (pcase (transient-arg-value "--object=" args)
                                ("line" (list 'svg-line
                                              (car start-coords) (cdr 
start-coords) (car end-coords) (cdr end-coords)))