Add basic usage instructions #90

Closed
opened 2026-01-19 18:29:12 +00:00 by michael · 2 comments
Owner

Originally created by @imikejackson on GitHub.

Originally assigned to: @jmahlman on GitHub.

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?

Originally created by @imikejackson on GitHub. Originally assigned to: @jmahlman on GitHub. ### 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 <!-- How are we going to solve the problem? --> ### Documentation <!-- Relevant documentation to the feature--> ### Testing None. More people will use this. ### What does success look like, and how can we measure that? <!-- Define both the success metrics and acceptance criteria. Note that success metrics indicate the desired business outcomes, while acceptance criteria indicate when the solution is working correctly. If there is no way to measure success, link to an issue that will implement a way to measure this. --> ### Links / references <!-- Any relevant links or references -->
Author
Owner

@jmahlman commented on GitHub:

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 commented on GitHub: Hi there. The [wiki](https://github.com/usnistgov/macos_security/wiki) contains a good deal of usage information. While we know it could use some updates, the instructions on use are there.
Author
Owner

@brodjieski commented on GitHub:

The information in the wiki is now available in a site that can help navigate getting started with the project. Visit: https://pages.nist.gov/macos_security to see more!

@brodjieski commented on GitHub: The information in the wiki is now available in a site that can help navigate getting started with the project. Visit: https://pages.nist.gov/macos_security to see more!
Sign in to join this conversation.
No Label
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: usnistgov/macos_security#90