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.

Sign up for GitHub

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

Jump to bottom

Add instructions to readme #4

Open
3 of 5 tasks
MrMino opened this issue Sep 7, 2020 · 2 comments
Open
3 of 5 tasks

Add instructions to readme #4

MrMino opened this issue Sep 7, 2020 · 2 comments
Labels
📜 documentation Improvements or additions to documentation

Comments

@MrMino
Copy link
Owner

MrMino commented Sep 7, 2020 •
edited
Loading

Current README.md contents lack:

  • A nice elevator pitch for the project
  • Installation instructions (links to Docker installation guide, pip install dockernel)
  • How to install a kernel into Jupyter using Dockernel (usage)
  • Fast installation of different kernels with Images by Dockernel (Images by Dockernel #2)
  • How to create a proper Docker image for use with Dockernel (detailed instructions)
@MrMino MrMino added the 📜 documentation Improvements or additions to documentation label Sep 7, 2020
@pryadchenko
Copy link

Hello! Could you please provide a brief explanation how to use it? Thanks.

@MrMino
Copy link
Owner Author

MrMino commented Mar 22, 2021

@eric-valente @pryadchenko I think that the current version of README should suffice. I also added 2 dockerfile examples in the repository root to help you out.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
📜 documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@pryadchenko @MrMino