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

Alternate (simpler?) instructions on the README #45

Open
jpivarski opened this issue Aug 13, 2024 · 0 comments
Open

Alternate (simpler?) instructions on the README #45

jpivarski opened this issue Aug 13, 2024 · 0 comments
Labels
bug Something isn't working

Comments

@jpivarski
Copy link

Describe the bug

I tried to follow the example on the README:

$ cookiecutter [email protected]:executablebooks/cookiecutter-jupyter-book.git

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
@jpivarski jpivarski added the bug Something isn't working label Aug 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

1 participant