Skip to content

Readme needs updates #9

@shbonita

Description

@shbonita

The instructions need to be made more clear. For example, state that the repository needs to be downloaded and unzipped. on your machine.

Also, state how to launch a Python program. Double clicking a py file does not launch it. One method could be to state the command to run on command line or open in PyCharm IDE and run. Both options should be listed.

This line "To run iTrace-Visualize, make sure a recent version of Python 3 is installed, and run pip install -r requirements.txt to install the required dependencies. Visualization.py is the main script." needs to be elaborated on with the above feedback. It does not say how to run the file rather how to run the dependencies install.

Finally, change the name of the main script file as there is no file named Visualization.py

All of the above is based off of user feedback.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions