-
Notifications
You must be signed in to change notification settings - Fork 16
Install instruct updates #133
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
xckev
wants to merge
2
commits into
master
Choose a base branch
from
install-instruct-updates
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -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 | ||
| instructions here: https://www.cairographics.org/download/ under the Binary Packages section. | ||
| - Eigen3, a header-only linear algebra and numerical methods library. On Debian, `apt install | ||
| libeigen3-dev`. Elsewhere, download the latest stable release from https://eigen.tuxfamily.org/. | ||
|
|
@@ -37,10 +37,12 @@ You need Linux or macOS. On Windows, we recommend installing the Windows Subsyst | |
|
|
||
| - Download [Homebrew](https://brew.sh/), run `/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"` in terminal | ||
| - Install [cairo](https://formulae.brew.sh/formula/cairo#default) via homebrew `brew install cairo` | ||
| - Locate the cairo folder within the 'include' directory of the installed cairo package. Move it into the vendor directory so that the cairo files are in `vendor/cairo` under the LOST repository | ||
| - Install [Eigen]("https://formulae.brew.sh/formula/eigen#default") via homebrew `brew install eigen` | ||
| - Locate Eigen files and move them to `vendor/eigen3/Eigen` under the LOST repository | ||
| - Locate the eigen3 folder within the 'include' directory of the installed Eigen package. Move it into the vendor directory so that the eigen files are in `vendor/eigen3/Eigen` under the LOST repository | ||
| - 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. | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. a user should never have to modify a makefile or other source code as part of a normal build process. |
||
|
|
||
| ### Building | ||
|
|
||
|
|
||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Debian recommends using
aptinstead ofapt-getwhen used interactively at the command-line; apt-get is only meant for use by automation.