Install instruct updates #133
Open
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
| @@ -26,7 +26,7 @@ You need Linux or macOS. On Windows, we recommend installing the Windows Subsyst | |||
| - (Recommended) ASAN (Address Sanitizer). We use this to catch memory errors early. `apt install libasan`. (If you wish to use LOST without the address sanitizer, build it with `make LOST_DISABLE_ASAN=1`, or set `export LOST_DISABLE_ASAN=1` in your `~/.bashrc` file to disable it every time you build). | |||
| - Git. On Debian, `apt install git` | |||
| - Cairo, to read and write PNGs as well as draw on them for debugging and demo purposes. You won't | |||
| need this on your CubeSat. On Debian, `apt install libcairo2-dev`. Elsewhere, follow the | |||
| need this on your CubeSat. On Debian, `sudo apt-get install libcairo2-dev`. Elsewhere, follow the | |||
There was a problem hiding this comment.
Debian recommends using apt instead of apt-get when used interactively at the command-line; apt-get is only meant for use by automation.
| - Install [groff]("https://formulae.brew.sh/formula/groff#default") via homebrew `brew install groff` | ||
| - If you get errors mentioning 'ASAN' or 'AddressSanitizer', try `make clean` and then `make LOST_DISABLE_ASAN=1` to disable ASAN. See the Linux section above for more details. | ||
| - On Apple Silicon, if you an error like `error: linker command failed with exit code 1` or `library 'cairo' not found`, set LIBS in the Makefile to `LIBS = -L/opt/homebrew/lib -lcairo` and add a line `CFLAGS = -I/opt/homebrew/include/cairo` under it. |
There was a problem hiding this comment.
a user should never have to modify a makefile or other source code as part of a normal build process.
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.
PR for improving installation instructions.
If you have improvements to report, please comment it on this PR and it will be added onto this branch for merge