search

lambdalisue / jupyter-vim-binding

Jupyter meets Vim. Vimmer will fall in love.
2.1k stars 136 forks source link

Adding a brief ‘Usage’ section to the README #52

Closed ELLIOTTCABLE closed 8 years ago

ELLIOTTCABLE commented 8 years ago

This could really even use further elaboration, but this is the extent of my knowledge. To be honest, the entire README needs a re-write, though, so I decided not to tackle that.

See: #47.

lambdalisue commented 8 years ago

I'm sorry but jupyter-vim-binding will be moved on to version 2.0.0 today (within several hours) and that version has completely different README.

I partially applied your changes but the new README already have Usage section. I know my English is not good enough so if you send me a PR for new version. I'm willing to merge that.

ELLIOTTCABLE commented 8 years ago

Just another comment on the help: discovering right now that it's useful to be able to open it in a separate window. (Personally, using my iPad, but …)

I can open a second window into the Jupyter instance, but it'd be nice to have a simple, clean page with just the content of F1.

(Also, to be honest, even with v2.0.0, I still find the contents of F1 very confusing; but that's more due to the issues mentioned in #56: inability to override Jupyter's default textual header, which doesn't really jive with how things work once vim-mode is installed … unfortunate. A seperate documentation page wouldn't have that problem. ;))

lambdalisue commented 8 years ago

Hum... why don't you use Wiki then ?