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

Jupyter notebook for un cluttering README #118

@Manusreekumar

Description

@Manusreekumar

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    docsDocumentation work

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions