Update Mbot instructions and hitchhiker's guide #6105
Merged
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
knelli2
requested changes
Jun 20, 2024
Comment on lines
119
to
122
| 1. Run `export SPECTRE_HOME=/path/to/where/you/want/to/clone` | ||
| 2. Clone SpECTRE using `git clone SPECTRE_URL $SPECTRE_HOME` where the | ||
| `SPECTRE_URL` is the GitHub url you want to use to clone the repo. | ||
| 3. Run `cd $SPECTRE_HOME && mkdir build && cd build` |
There was a problem hiding this comment.
I'd remove these. No need to repeat them, you already say follow steps 1-3. (also these can very easily get out of sync if we update the instructions)
docs/Tutorials/BeginnersTutorial.md
Outdated
Comment on lines
206
to
207
|
|
||
| The `&` is so that the server runs in the background. If you hit `Enter` a | ||
| couple times you'll get back to being able to type commands. You should see some | ||
| output similar to | ||
| *Note* on compute clusters you should use the cluster-specific instructions for |
nilsdeppe
force-pushed
the
mbot_and_hitchhiker
branch
from
d8c3de5
to
01c9b98
Compare
|
Done and squashed! Thanks for the review :) |
knelli2
approved these changes
Jun 21, 2024
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.
Proposed changes
Upgrade instructions
Code review checklist
make docto generate the documentation locally intoBUILD_DIR/docs/html.Then open
index.html.code review guide.
bugfixornew featureif appropriate.Further comments