Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add install instructions and workflow for coding text #2

Open
antics opened this issue Feb 6, 2022 · 3 comments
Open

Add install instructions and workflow for coding text #2

antics opened this issue Feb 6, 2022 · 3 comments

Comments

@antics
Copy link

antics commented Feb 6, 2022

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

@andersjohansson
Copy link
Owner

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.

@antics
Copy link
Author

antics commented Feb 8, 2022

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.

@andersjohansson
Copy link
Owner

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants