Update README #17
Update README #17
Conversation
|
|
||
| ```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
There was a problem hiding this comment.
That's fair, I do call out that the install script in the toolkit is recommended but since the instructions walk through manual setup maybe permission instructions are needed.
There was a problem hiding this comment.
I added sudo prior to each command since elevated permissions should be required for these actions.
| 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?
There was a problem hiding this comment.
After reviewing the instructions this is dependent on running the install script on the mesa-toolkit repo first. So if I'm understanding this comment, your suggesting that I should include instructions on how to do so?
|
|
||
|  | ||
|
|
||
| | Job Title | Description | Required | |
There was a problem hiding this comment.
might be worth mentioning (just above this) what required means in this context
There was a problem hiding this comment.
I added a note to this section.
README.md
Outdated
| 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
There was a problem hiding this comment.
Added another note to explain why the scan is required and modified recommended to required.
🗣 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.