summaryrefslogtreecommitdiff
path: root/docs/BUILDING_MACOS.md
blob: ef8758c33e9b132be16805b0496bc019d34dcd20 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
# Building on macOS

**N.B. C++17 is required to build the asset processing program that we use (ZAPD), so check your OS version can support this before proceeding**

## Dependencies

For macOS, use Homebrew to install the following dependencies:

* coreutils
* make
* python3
* libpng
* bash
* libxml2
* libiconv

You can install them with the following commands:

```bash
brew update
brew install coreutils make python3 libpng bash libxml2 libiconv
```

(The repository expects Homebrew-installed programs to be either linked correctly in `$PATH` etc. or in their default locations.)

Homebrew does not have clang-format-14 but MacPorts does

(Have been unable to confirm actual commands with somone that has a Mac)

## Building mips-linux-binutils

The following instructions are written for MacOS users but should apply to any Unix-like system, with maybe some modifications at the end regarding the bash_profile.

Create destination dir for binutils

```bash
sudo mkdir -p /opt/cross
```

Create and enter local working dir

```bash
mkdir ~/binutils-tmp
cd ~/binutils-tmp
```

Get and extract binutils source

```bash
curl -O https://ftp.gnu.org/gnu/binutils/binutils-2.35.tar.bz2
tar xjf binutils-2.35.tar.bz2
```

(You may find this command does not work: if so, just access the URL in a browser and save it to `~/binutils-tmp`.)

Create and enter a build directory

```bash
mkdir build-binutils
cd build-binutils
```

Configure the build

```bash
../binutils-2.35/configure --target=mips-linux-gnu --prefix=/opt/cross --disable-gprof --disable-gdb --disable-werror
```

Make and install binutils

```bash
make -j
sudo make install
```

Edit your `~/.bash_profile`/`~/.zprofile` (or whichever shell you use) to add the new binutils binaries to the system PATH

```bash
echo 'export PATH="$PATH:/opt/cross/bin"' >> ~/.bash_profile
```

Reload ~/.bash_profile (or just launch a new terminal tab)

```bash
source ~/.bash_profile
```

If this worked, you can now delete the temporary directory `~/binutils-tmp`.

## Final note

Apple's version of `make` is very out-of-date, so you should use the brew-installed `gmake` in place of `make` in this repo from now on.

You should now be able to continue from [step 2](../README.md#2-clone-the-repository) of the Linux instructions.