docs: fix and extend build instructions #13
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
mbrobbel
approved these changes
Nov 6, 2024
|
Thanks @mbrobbel for the review! (I still have to wait for a review from someone with write access...) |
ingomueller-net
changed the title
jpienaar
approved these changes
Nov 23, 2024
The README still had example commands related to the historic usage of this repository. This PR cleans them up and make them use actual files that exist currently. Signed-off-by: Ingo Müller <[email protected]>
This commit fixes several problems with the build instructions in the README and extends them. In particular, the following changes are made: * List global prerequisites (like git, CMake, C++ compiler, etc.) * Fix base path and define it as a first step * Explicitly describe what paths to add to the `activate` script, including `PATH`, and adapt following commands to that * Mention possible problems with using `lld` * Remove the quirk with `-DABSL_ENABLE_INSTALL=ON` -- this doesn't seem to be necessary anymore * Remove `lit` from the Python requirements because LLVM provides it in the `PATH` Signed-off-by: Ingo Müller <[email protected]>
Signed-off-by: Ingo Müller <[email protected]>
ingomueller-net
force-pushed
the
readme-example-tests
branch
from
b56ac1d to
887e3ac
Compare
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.
This commit fixes several problems with the build instructions in the README and extends them. In particular, the following changes are made:
activatescript, includingPATH, and adapt following commands to thatlld-DABSL_ENABLE_INSTALL=ON-- this doesn't seem to be necessary anymorelitfrom the Python requirements because LLVM provides it in thePATHlitexamples to the new repository structure