search

kiyoon / jupynium.nvim

Selenium-automated Jupyter Notebook that is synchronised with NeoVim in real-time.
MIT License
520 stars 15 forks source link

Updated the README to simplify steps for new users #51

Closed sho-87 closed 1 year ago

sho-87 commented 1 year ago

Addresses some of the issues discussed in #44

kiyoon commented 1 year ago

Overall it looks really good! Thanks for doing this :)

I think the Usage section is definitely improved, but also it got longer. I also think it may be easier to understand if they just try it out and read the rest.

How about making a section like this?

## Quick Start
- Open a `*.ju.py` file.
- Execute `:JupyniumStartAndAttachToServer`. This will open Jupyter Notebook on the Firefox browser.
  - If not, clarify option `jupyter_command` or just open the Notebook server by yourself: `jupyter notebook`
- Execute `:JupyniumStartSync`. This will create an `Untitled.ipynb` file on the browser.
- Now you can type `# %%` in Neovim to create a code cell.
  - You'll see everything you type below that will be synchronised in the browser.
  - Execute cells using the default keybind `<space>x`.

For detailed instructions, see Usage.
sho-87 commented 1 year ago

Everything you mentioned makes sense, especially the quickstart section. Added everything in the latest commit

kiyoon commented 1 year ago

Fab! Thank you so much again!