Update README #17
Open
Update README #17
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
coffeegist
reviewed
Oct 18, 2024
|
|
||
| ```bash | ||
| git clone https://github.com/cisagov/mesa-gui | ||
| cd /opt/ |
There was a problem hiding this comment.
Is this always going to be writeable? Or do we need to include permission changes here? Not sure that /opt is writeable by users by default
| Source the MESA virtual environment. This activates the environment, isolating the dependencies needed for the MESA-GUI to run: | ||
|
|
||
| ```bash | ||
| source /opt/MESA-venv/bin/activate |
There was a problem hiding this comment.
This is created by the mesa-toolkit installer right? Might be worth mentioning as a bash comment, but if this is walking through the installation as if mesa-toolkit was not used, should we also include creating the venv?
|
|
||
|  | ||
|
|
||
| | Job Title | Description | Required | |
There was a problem hiding this comment.
might be worth mentioning (just above this) what required means in this context
| MESA jobs can be ran individually or automatically in sequential order. To run the scans individually simply select the  button for the job you would like to run. | ||
|
|
||
| >[!IMPORTANT] | ||
| >It is recommended to run the `Host Discovery Scans` job prior to running any other scans. This will ensure that a `live hosts` file is generated, expediting the time spent performing scans. |
There was a problem hiding this comment.
recommended or required? Kind of tying this in with the comment above about what required means
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
🗣 Description
Update the MESA-GUI README to include more clear instructions on how to use the tool.
💭 Motivation and context
Additional context can be found in issue #16
🧪 Testing
✅ Pre-approval checklist
to reflect the changes in this PR.