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

Missing quickstart instructions #75

Open
chmreid opened this issue Dec 4, 2019 · 0 comments
Open

Missing quickstart instructions #75

chmreid opened this issue Dec 4, 2019 · 0 comments
Assignees

Comments

@chmreid
Copy link
Collaborator

chmreid commented Dec 4, 2019

This repo is missing quickstart instructions for the consumer vignettes. For example, the words "Jupyter Notebook" never appear in the README. The user is not told how to install packages they will need to run various notebooks, or how to run the notebooks themselves once they get software installed. Some notebook folders have their own requirements.txt, while others do not. Some consumer vignettes are Markdown files, others are Jupyter notebooks.

The user's experience depends on what vignettes the user starts with and how well they know Python. As is, it would be confusing and difficult to get started, even for someone knowledgeable with Python.

Definition of Done: README file has a quickstart section that explains how to get started and provides some commands that users can copy-and-paste into their terminal. Someone relatively new to Python can start from this repo's README and successfully install/run a notebook without needing to refer to StackOverflow or pick over the source code/Makefiles/YML files in this repo.

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