Skip to content

Alternate (simpler?) instructions on the README #45

@jpivarski

Description

@jpivarski

Describe the bug

I tried to follow the example on the README:

$ cookiecutter git@github.com: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

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't working

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions