Skip to content
This repository has been archived by the owner on Apr 16, 2023. It is now read-only.

Jupyter notebook for un cluttering README #118

Open
Manusreekumar opened this issue Oct 9, 2019 · 0 comments
Open

Jupyter notebook for un cluttering README #118

Manusreekumar opened this issue Oct 9, 2019 · 0 comments
Labels
docs Documentation work

Comments

@Manusreekumar
Copy link
Contributor

README is clear in terms of the steps, but could look excessively long for new users. In order to de clutter README, it would be good to create an example notebook that moves most of the setup work from README, so that README could serve

a. Purpose of Package
b. Inputs Required and Expected output
c. Examples of Output format / interesting Gifs
d. Any system level setups that needs to be taken care of for using package

@bburns632 bburns632 added the docs Documentation work label Oct 9, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
docs Documentation work
Projects
None yet
Development

No branches or pull requests

2 participants