Skip to content

Change README composition and add more information about running #103

@asgibson

Description

@asgibson

The current README offers no explanation of anything in the system except:

  • creating a Conda environment (doesn't explain why or what to do afterward)
  • running unit tests (important but comprises the bulk of the README)
  • License and contributor information

Need to add things like how to:

  • write a config.ini file
  • write a plugin
  • run

Additionally, information about system flow.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationhelp wantedExtra attention is needed

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions