Skip to content

Commit

Permalink
docs: note about mac os
Browse files Browse the repository at this point in the history
  • Loading branch information
katrinafyi authored Sep 27, 2024
1 parent 4fb69f1 commit 98f2678
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions docs/usage.md
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

0 comments on commit 98f2678

Please sign in to comment.