branch: externals/sketch-mode
commit f82ed74c6e7d1c6ba92bcb5e5a3439914389585e
Author: Daniel Nicolai <dalanico...@gmail.com>
Commit: Daniel Nicolai <dalanico...@gmail.com>
Update documentation (add screencast)
---
README.org | 63 ++++++++++++++++++++++++++++++++++++++++++----------
happy-sketching.gif | Bin 0 -> 2063069 bytes
happy-sketching.svg | 1 +
sketch-mode.el | 5 +++--
4 files changed, 55 insertions(+), 14 deletions(-)
diff --git a/README.org b/README.org
index 4e7bb4c..4284f79 100644
--- a/README.org
+++ b/README.org
@@ -3,12 +3,34 @@
* 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).
+ functionality is very usable already. Any feedback, for example suggestions
+ for enhancing the interface/usability, is very welcome (probably best by
+ opening an issue). Also, any contributions are very welcome. The code of the
+ package is very accessible (especially if you quickly read how to use
[[https://www.gnu.org/software/emacs/manual/html_node/elisp/Edebug.html][edebug]].
+
+** Included features
+ - snap to grid
+ - draw text
+ - crop finale image
+ - set stroke, fill, width etc.
+ - show dom (lisp) in other window
+ - draw angle arcs (between lines, available soon)
+ - save drawing presets using
[[https://magit.vc/manual/transient.html#Saving-Values][transient's saving
values feature]] (documentation
+ contribution welcome)
+
+** Delicious low hanging fruit
+ - use svg snippets (i.e. design object in external programs like inkscape,
+ geogebra etc., end quickly insert them in your sketches)
+ - export to tikz, asymptote, other image extensions etc.
+
+** Less low hanging fruit
+ - draw directly in you literate org file, with the dom updated in your
source block
+
+ The =sketch-mode.el= file starts with listing TODO items describing features
+ that are missing from the package.
+
+ [[./happy-sketching.gif]]
- 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.
@@ -45,16 +67,33 @@
* 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.
+ with =C-u= to use default values). Although, thanks to the =transient=
+ package, the usage is more or less self explanatory, it is wise to take note
+ of the following comments:
+
+ - the undo/redo functionality is really basic, and does not work for all
actions
+ (e.g. does not work yet when removing object or cropping images).
+ - to remove an object (without using undo), you should toggle labels by
+ pressing =l=, and then to remove an object enter its label after pressing
+ =R=.
+ - You can hide the transient by pressing =q=, and you can go back to sketch
+ mode via =M-x sketch= (or =C-c C-t= when still in the sketch-mode buffer)
- Create your sketch and then save the file by pressing =S=.
+ Create your sketch and then save
+ the file by pressing =S=.
* Sponsor the project
- Due to a combination of unfortunate circumstances, I am in an unfortunate
- financial situation (dependent on my family), therefore if you find [[my
- package(s)]][project page link to be inserted] useful, and if you can afford
it,
- then I would be very happy with any small (or less small) donation.
+ It takes me a lot of time to develop these packages, while, as we would say
in
+ the Netherlands, I have no penny to scratch my butt. Therefore, although I am
+ also really happy to offer it for free, if you find
[[https://github.com/dalanicolai][my package(s)]] (real
+ projects page in the making) useful (e.g. for you work), and if you can
afford
+ it, then I would be very happy with any donation. 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.
+
+ If you would like to =boost= development of any of my projects, then
+ contribute (code or documentation), or consider more sustainable financial
+ support (i.e. sponsor).
Accepted donation methods
[[https://en.liberapay.com/dalanicolai/][liberapay]]
diff --git a/happy-sketching.gif b/happy-sketching.gif
new file mode 100644
index 0000000..ef5aaae
Binary files /dev/null and b/happy-sketching.gif differ
diff --git a/happy-sketching.svg b/happy-sketching.svg
new file mode 100644
index 0000000..e7bf00d
--- /dev/null
+++ b/happy-sketching.svg
@@ -0,0 +1 @@
+<svg width="800" height="600" version="1.1" xmlns="http://www.w3.org/2000/svg";
xmlns:xlink="http://www.w3.org/1999/xlink"; stroke="gray"> <defs> <marker
id="arrow" viewBox="0 0 10 10" refX="5" refY="5" markerWidth="8"
markerHeight="8" orient="auto"> <path d="M 0 0 L 10 5 L 0 10 z"
fill="black"></path></marker></defs> <rect width="800" height="600" x="0" y="0"
fill="white"></rect> <line x1="50" x2="750" y1="300" y2="300" id="a"
marker-end="none" fill="none" stroke="black"></line> <line x1= [...]
\ No newline at end of file
diff --git a/sketch-mode.el b/sketch-mode.el
index f4b3f2f..547e510 100644
--- a/sketch-mode.el
+++ b/sketch-mode.el
@@ -33,8 +33,6 @@
;; DONE add remove (objects) functionality (see `svg-remove')
-;; TODO add text objects
-
;; TODO move font transient (also its suffix) into main sketch transient
(suffix)
;; TODO add functionality to crop/select part of image (on save)
@@ -55,6 +53,9 @@
;; TODO add clipping fuctionality (see `svg-clip-path')
+;; TODO create function to insert svg snippets (so you could design objects in
+;; advanced software and use them quickly here in your sketches)
+
;; NOTE this is a most straightforward sketch-mode. A more advanced/general
version
;; could implement a drawing DSL based on nodes (a la tikz/asymptote etc.)
