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

README enhancement : "Usage" section only applies to Unix/Linux #95

Open
TonyGravagno opened this issue Mar 17, 2024 · 0 comments
Open

Comments

@TonyGravagno
Copy link

From the README:

Usage: JupyterLab and Jupyter Notebook
After you register tslab to Jupyter, start JupyterLab and Jupyter Notebook as usual. You can now create JavaScript and TypeScript notebooks.

That is followed by the CLI for either jupyter lab or jupyter notebook as executed from shell. However, it's written like a single script to be executed and it's not clear that this is for Unix/Linux only. A Windows user will almost never execute it like that.

Suggested text enhancement:

You can now create JavaScript and TypeScript notebooks. Unix/Linux users will execute one of the following two commands, depending on the platform. Windows users should have a shortcut, and probably will only use these commands from scripts.

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

1 participant