Skip to content
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.

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

Add basic usage instructions #413

Open
imikejackson opened this issue Aug 26, 2024 · 1 comment
Open

Add basic usage instructions #413

imikejackson opened this issue Aug 26, 2024 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@imikejackson
Copy link

Problem to solve

There are no actual usage instructions?

Intended users

Everyone

Further details

I would expect the ReadMe.adoc to contain something along the lines of "python scripts/some_python_script.py

Proposal

Documentation

Testing

None. More people will use this.

What does success look like, and how can we measure that?

Links / references

@jmahlman
Copy link
Collaborator

Hi there. The wiki contains a good deal of usage information. While we know it could use some updates, the instructions on use are there.

@jmahlman jmahlman self-assigned this Sep 5, 2024
@jmahlman jmahlman added the documentation Improvements or additions to documentation label Sep 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

6 participants
@imikejackson @jmahlman and others