Skip to content

improve docs #1

Description

@ikramhasan

Currently all the usage process exists in the readme file. We can improve it by doing the following:

  • Put each script to it's own folder and remove the current src folder.
  • Add a readme file for each script in their corresponding folder with prerequisites and installation instructions.
  • Remove the installation section from the main readme and point to the individual script readme(s) instead.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomershelp wantedExtra attention is needed

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions