Skip to content
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.

Sign up for GitHub

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

docs: note about mac os #253

Closed
wants to merge 1 commit into from
Closed

docs: note about mac os #253

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions docs/usage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,19 @@ See also: [tool-installation](development/tool-installation.md)
and [development: building](development/readme.md#building)
(primarily if you are interested in building BASIL manually).

#### Mac OS

The Mac OS platform (both x86 and arm64)
uses a different binary format (Mach-O instead of ELF),
so you will need to install and use a cross-compiler targeting aarch64-unknown-linux-gnu such as the one here:
https://github.com/messense/homebrew-macos-cross-toolchains
This means the commands for gcc and readelf might be different from those shown below.
The Nix commands should work unchanged.
Some scripts/makefiles within the repository
might also need tweaks.
Mac OS is a less supported platform,
please report any issues.

### Preparation

1. Compile a C program into an Aarch64 binary, for example:
Expand Down