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

Improve guidance for examples & testsΒ #78

@ejm554

Description

@ejm554

It took me a few tries to figure out how to run the Lua files in the examples directory. I think some adjustments could have avoided this. I wonder if other people had a similar experience or weren't able to figure it out outright. Here's what I learned by trial & error:

  1. I needed to download the entire set of directories on GitHub, i.e., remodel-master.

  2. I needed a temp directory in remodel-master to avoid an error, such as the following.

    image


Here are a few ideas that might help:

  1. Explicitly explain in the README or somewhere else what a person should do to prepare their device to run the example scripts. For example, "To try the example scripts, download the entire repository to a location on your device, such as your C: drive."

  2. Instruct the user to create an empty temp directory or (if possible) include this directory in the repository so it doesn't need to be created. (If tests/scripts.rs is designed to do this for the user, then explain what the user needs to do to run this file, e.g., install Rust, and how/when they should run it.)

  3. Adjust the error message(s) to provide additional detail. For example:

    The system cannot find the path specified ("C:\remodel-master\temp\")

  4. A walk-through tutorial would also be nice-to-have, but it's understandable that the effort required to do this may not be available. Not yet anyway.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions