search

executablebooks / cookiecutter-jupyter-book

Cookiecutter template for a simple jupyter book
https://executablebooks.github.io/cookiecutter-jupyter-book/
BSD 3-Clause "New" or "Revised" License
140 stars 53 forks source link

Alternate (simpler?) instructions on the README #45

Open jpivarski opened 1 month ago

jpivarski commented 1 month ago

Describe the bug

I tried to follow the example on the README:

https://github.com/executablebooks/cookiecutter-jupyter-book/blob/3977128cd5088f076ca67e3e72385153fc7feb04/README.md?plain=1#L52

and had ssh troubles with github.com. I usually access it via HTTPS.

This worked, and I think it's simpler:

cookiecutter gh:executablebooks/cookiecutter-jupyter-book

Including too many options can be confusing for new users. Would the gh: option work for a larger set of users than the git@ ones? If so, then it can be the only instructions.

For comparison, https://github.com/scientific-python/cookie describes this method as well as one using copier instead of cookiecutter.

Reproduce the bug

See above.

List your environment

% jupyter-book --version

Jupyter Book      : 1.0.2
External ToC      : 1.0.1
MyST-Parser       : 2.0.0
MyST-NB           : 1.1.1
Sphinx Book Theme : 1.1.3
Jupyter-Cache     : 1.0.0
NbClient          : 0.10.0