Correct install instructions for compiling from source #950
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
Adds the `-r` flag to the cargo build command to ensure the following step that checks for a successful build runs correctly. Currently a debug build is produced and the following command attempts to run a release version of the code that has never been built. Also adds instructions to change directories into the Fe repository directory before attempting to build.
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.
What was wrong?
Currently a debug build is produced and the following command attempts to run a release version of the code that has never been built.
How was it fixed?
Adds the
-rflag to the cargo build command to ensure the following step that checks for a successful build runs correctly.Also adds instructions to change directories into the Fe repository directory before attempting to build (following current instructions step-by-step would lead to failures).
To-Do
OPTIONAL: Update Spec if applicable
Add entry to the release notes (may forgo for trivial changes)
Clean up commit history