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

How does it work? #26

Closed
gonutz opened this issue Sep 5, 2019 · 3 comments
Closed

How does it work? #26

gonutz opened this issue Sep 5, 2019 · 3 comments

Comments

@gonutz
Copy link

gonutz commented Sep 5, 2019

Please include a usage section in your readme, I like the idea of a console editor written in Go, I was recently looking for a good one and ended up writing my own.
The only problem is that I have no idea how to use your editor. Instead of the "why" section I would rather like to have a concise manual with all keyboard shortcuts and possible command line parameters explained.
Also I was trying to call bed with -h --help and /? which I think should all really print the same kind of help that should be in the readme.
Thanks very much for sharing this editor!

@itchyny
Copy link
Owner

itchyny commented Sep 7, 2019

This editor is influenced by Vim so most of the basic operation of Vim is supported, including modes. I don't list all the keyboard shortcuts in README.md but I'll add some notes for basic operations.

@gonutz
Copy link
Author

gonutz commented Sep 7, 2019

Why don't you list all keyboard shortcuts in the readme? That is exactly where they belong, isn't it?
I am not at all familiar with vim as are most people on this planet. Why would you assume that someone who reads about this editor in the Go Newsletter knows anything about vim? Even the hardcore text editor people are split into emacs and vim camps! :-)
Please reconsider how essential it is to know how a program works. Do not alienate most of your potential userbase by not helping them out in the most basic way.

@itchyny
Copy link
Owner

itchyny commented Sep 8, 2019

Wow, linked from Go Newsletter? I noticed that now. How honored it is.
Note that README is not always the best place to list all the usage. README of both Vim and Emacs does not do it.
I'm thinking of creating embedded help which user can open with :h (which was listed in #1). But recently I don't have time for this project. Anyway, now that I wrote basic usages in README.md so closing.

@itchyny itchyny closed this as completed Sep 8, 2019
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