search

hlissner / evil-snipe

2-char searching ala vim-sneak & vim-seek, for evil-mode
MIT License
340 stars 25 forks source link

Better docs? #16

Closed ghost closed 9 years ago

ghost commented 9 years ago

Would you be interested in a PR with an explanation of evil-snipe? I imagine that the images are kinda hard to understand, and that some visitors that aren't going to spend more than two secs to read the page and not understand anything and leave.

I feel that one of the first things on the page should be something like "what can evil-snipe do for me?", like I wrote for the spacemacs contrib layer: https://github.com/syl20bnr/spacemacs/tree/master/contrib/evil-snipe#description but more thorough.

hlissner commented 9 years ago

I agree, it needs work. I'll sit down one of these weekends and suss something out.

hlissner commented 9 years ago

Er, I forgot to reply about the PR: certainly, go ahead. I'll look it over as soon as I can.

ghost commented 9 years ago

Feel free to look at the spacemacs contrib layer readme for inspiration:

https://github.com/syl20bnr/spacemacs/pull/754/files

hlissner commented 9 years ago

Just got around to this and could use a fresh pair of eyes on the new readme; what do you think?

The images have been taken down for now, I'm still figuring out a better way to do that.

ghost commented 9 years ago

I think it looks good. All users will be fairly technical so no need to make it simpler. Perhaps you should try spreading the gospel to hacker news or something.

I guess the easiest way to show people what evil snipe is about is having an online demo (normal mode only) where you could try using the keycombos to jump around. But without knowing anything about web-programming, that is with a probability of 99.999 % certainity more trouble than it is worth.

ghost commented 9 years ago

Emacs celeb endorsement: https://twitter.com/syl20bnr/status/610878194137305088

hlissner commented 9 years ago

Awesome! Thanks for letting me know!