New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add documentation to VTPEmulator directory #51

Open

6 tasks

faustus123 opened this issue Sep 9, 2024 · 0 comments

Assignees

Milestone

Contributor

faustus123 commented Sep 9, 2024

The VTPEmulator directory lacks documentation to say what is the exact functionality of its code and how to run it. This should include:

Overview of the functionality of the code this directory contains
Examples of how to run the code demonstrating the functionality
- Include instructions for obtaining any needed input files so a new user can run the examples
Description of sub-directory organization
Short descriptions of each of the scripts/programs

This may also include any clean-up of the code that may be needed to remove undocumented files that are no longer useful.

Rename tmpFiles and tempFiles to something that sounds more permanent and less "temporary"

faustus123 added this to the M08 milestone

faustus123 assigned AyanRoy16

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