update readme with paste image section #925
Conversation
README.md
Outdated
|
|
||
| The extension provides a quick command to paste an image from clipboard. | ||
|
|
||
| * Create a screenshot thats in the clipboard |
There was a problem hiding this comment.
Might be too specific? "Copy an image in your clipboard" ?
There was a problem hiding this comment.
Yes, great idea! This is the more generic approach. My usecase actually was: take a screenshot and put in in a adoc document.
But put an image to clipboard is more versatile, should also work e.g. for remote sessions on other hosts.
| * Open the command palette - `ctrl+shift+p` or `F1` (Mac: `cmd+shift+p`) | ||
| * Select _AsciiDoc: Paste Image_ (or use the shortcut `ctrl+alt+v`, Mac: `option+cmd+v`) | ||
| * The png file with current timestamp is generated in the same folder | ||
| * in the working document an image macro is inserted |
There was a problem hiding this comment.
The last 2 bullets are not actions that the user must take, so I will probably convert them to a paragraph to describe what the user should see. What do you think?
There was a problem hiding this comment.
I looked on the previous headings. They also have bullets with "The file is generated ... " so there may be some consistency with the other features. i just wanted to point out what the feature is describe the outcome.
What do you think about this one sentence, instead of the two? Seems shorter and more generic.
Generates a timestamped image and inserts an image macro into the document.
There was a problem hiding this comment.
Hmmm good point, you're right we should probably be consistent. Since we are using passive sentence it should be:
An image file, named with a timestamp, is created, and an image macro is added to the document
Anyway, it really is a nitpick. Thanks for updating the documentation, I really appreciate it!
Co-authored-by: Guillaume Grossetie <[email protected]>
| * Open the command palette - `ctrl+shift+p` or `F1` (Mac: `cmd+shift+p`) | ||
| * Select _AsciiDoc: Paste Image_ (or use the shortcut `ctrl+alt+v`, Mac: `option+cmd+v`) | ||
| * The png file with current timestamp is generated in the same folder | ||
| * in the working document an image macro is inserted |
There was a problem hiding this comment.
Hmmm good point, you're right we should probably be consistent. Since we are using passive sentence it should be:
An image file, named with a timestamp, is created, and an image macro is added to the document
Anyway, it really is a nitpick. Thanks for updating the documentation, I really appreciate it!
Hi there,
just an update on the readme.md. need to stumble over #208 to find out how pasting an image works ;-)