Clarify how to run a locally built mirai. #525
Merged
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
The "Running" section of the developer guide has mixed instructions for using both a locally built binary and a globally installed binary, on both a single file (as rustc) and a crate (via cargo).
It also seems unnecessary to have instructions for globally installed binary, because they are covered somewhere else, and a developer just needs the locally built one during development.
This commit separates the instructions for single files from those for crates, updates all the commands to use a locally built binary, and tweaks the indentation in debug configurations.
Type of change
None of the above: only documentation change.
How Has This Been Tested?
Followed the instructions to build and run locally built mirai on both single files and crates.