orgqda icon indicating copy to clipboard operation
orgqda copied to clipboard

Add install instructions and workflow for coding text

Open antics opened this issue 3 years ago • 3 comments

Hi Anders,

Could you add an easy to follow "Installation" section in the readme and also maybe an overview of a text coding workflow?

A second request would be to add the package to MELPA.

Best, Michel

antics avatar Feb 06 '22 08:02 antics

That's good ideas, I’ll try to get to it soon. In the meantime do you think it would be better with a textual description or some kind of video for the coding workflow? And, if you do try it out, don’t hesitate to ask questions, I know that it is quite idiosyncratic and built after my own needs.

andersjohansson avatar Feb 08 '22 07:02 andersjohansson

Personally, I usually go for a textual description first. Something in the likes of:

  1. Mark text that is to be coded.
  2. C-[keyboard combo] to code marked text. (then explain how the you add the code. is it buffer or some markup tag?)
  3. Try to show how you visually can see which parts of the text are coded.

Also a descriptive list of what at least the main, or more important workflow commands do for the user.

antics avatar Feb 08 '22 11:02 antics

Hi @antics, I have rewritten and added some parts to the readme which should hopefully make it a bit more obvious how it all works (Installation and Getting started with coding). See what you think and feel free to give me more feedback on this (I’m also open to pull requests!) if you read it and try it out.

andersjohansson avatar Feb 20 '22 20:02 andersjohansson