diff --git a/README.md b/README.md index 4cf9e327..f7636894 100644 --- a/README.md +++ b/README.md @@ -51,12 +51,6 @@ to just write games for the Game Boy Advance using this library: for instructions for your operating system. * You can update rustup with `rustup update`, or using your package manager if you obtained rustup in this way. -* arm eabi binutils - * Debian and derivatives: `sudo apt install binutils-arm-none-eabi` - * Arch Linux and derivatives: `pacman -S arm-none-eabi-binutils` - * Windows can apparently use the [GNU Arm Embedded Toolchain](https://developer.arm.com/tools-and-software/open-source-software/developer-tools/gnu-toolchain/gnu-rm/downloads). - Make sure to select "Add path to environment variable" during the install. - * This process has only been tested on Ubuntu and Arch Linux. * libelf and cmake * Debian and derivatives: `sudo apt install libelf-dev cmake` * Arch Linux and derivatives: `pacman -S libelf cmake` diff --git a/book/src/setup/linux.md b/book/src/setup/linux.md index f96557f0..9e1ed6ae 100644 --- a/book/src/setup/linux.md +++ b/book/src/setup/linux.md @@ -9,21 +9,14 @@ Firstly, ensure that you have **rustup** installed which you can do by following If you have already installed rustup, you can update it with `rustup update`. -# 2. arm-none-eabi - -To assemble the small amount of assembly in agb and to do the final linking, you'll need to install the `arm-none-eabi` binutils. - -* On Debian and derivatives (like Ubuntu): `sudo apt install binutils-arm-none-eabi` -* On Arch Linux and derivatives: `pacman -S arm-none-eabi-binutils` - -# 3. git +# 2. git The source code for the game is hosted on github, so you will need to install git. * On Debian and derivatives (like Ubuntu): `sudo apt install git` * On Arch Linux and derivatives: `pacman -S git` -# 4. gbafix +# 3. gbafix In order to be able to play games made with agb on real hardware or on some emulators, you will need to install 'agb-gbafix'. Agb's implementation can be installed very easily using `cargo install agb-gbafix`. diff --git a/book/src/setup/mac.md b/book/src/setup/mac.md index 510765e3..49d563a3 100644 --- a/book/src/setup/mac.md +++ b/book/src/setup/mac.md @@ -9,30 +9,11 @@ Firstly, ensure that you have **rustup** installed which you can do by following If you have already installed rustup, you can update it with `rustup update`. -# 2. Install arm-none-eabi - -To assemble the small amount of assembly in agb and to do the final linking, you'll need to install the `arm-none-eabi` binutils. - -## Install from ARM - -Download the toolchain from [ARM here](https://developer.arm.com/downloads/-/gnu-rm) - * Run the .pkg to install - * Add `/Applications/ARM/bin` to your `/etc/paths` file - -## Install from Homebrew - -Or you can try installing with homebrew from the [Arm Mbed repo](https://github.com/ARMmbed/homebrew-formulae): - -``` -brew tap ArmMbed/homebrew-formulae -brew install arm-none-eabi-gcc -``` - -# 3. Get git +# 2. Get git The source code for the game is hosted on github, so you will need git installed. Follow the instructions at [git-scm.com](https://git-scm.com/) -# 4. GBA Emulator - mGBA +# 3. GBA Emulator - mGBA We recommend using the mGBA emulator which you can download for Mac [here](https://mgba.io/downloads.html). @@ -41,7 +22,7 @@ After installing to your `/Applications` folder you can add the binary to your p * Add `/Applications/mGBA.app/Contents/MacOS` to `/etc/paths` * Inside the `/Applications/mGBA.app/Contents/MacOS` directory (in a terminal) run: `ln -s mGBA mgba-qt` -# 5. Real hardware - gbafix +# 4. Real hardware - gbafix In order to be able to play games made with agb on real hardware or on some emulators, you will need to install 'agb-gbafix'. Agb's implementation can be installed very easily using `cargo install agb-gbafix`. diff --git a/book/src/setup/setup.md b/book/src/setup/setup.md index 2ad59c7f..0b06e74c 100644 --- a/book/src/setup/setup.md +++ b/book/src/setup/setup.md @@ -1,6 +1,6 @@ # Environment setup Environment setup will depend on the platform you are using. -agb's requirements are [rust nightly](https://www.rust-lang.org/) edition and the gnu binutils for `arm-none-eabi`. +You need to install the [rust nightly](https://www.rust-lang.org/) edition along with (optionally) some additional tools. See the sub-pages here for platform specific setup guides. diff --git a/examples/amplitude/README.md b/examples/amplitude/README.md index 2d488275..72b88027 100644 --- a/examples/amplitude/README.md +++ b/examples/amplitude/README.md @@ -12,11 +12,6 @@ all the boiler plate files for you. You will need the following installed in order to build and run this project: * A recent version of `rustup`. See the [rust website](https://www.rust-lang.org/tools/install) for instructions for your operating system -* `arm-none-eabi-binutils` for assembling and linking - * Windows: [GNU Arm Embedded Toolchain](https://developer.arm.com/tools-and-software/open-source-software/developer-tools/gnu-toolchain/gnu-rm/downloads). - Make sure you select "Add path to environment variable" during the install - * Debian and derivatives (e.g. Ubuntu, raspberry pi OS, linux mint): `sudo apt install binutils-arm-none-eabi` - * Arch linux and derivatives: `sudo pacman -S arm-none-eabi-binutils` You will also want to install an emulator. The best support in agb is with [mgba](https://mgba.io), with `println!` support via `agb::println!` but any emulator should work. You'll get the best experience if diff --git a/template/README.md b/template/README.md index 2d488275..72b88027 100644 --- a/template/README.md +++ b/template/README.md @@ -12,11 +12,6 @@ all the boiler plate files for you. You will need the following installed in order to build and run this project: * A recent version of `rustup`. See the [rust website](https://www.rust-lang.org/tools/install) for instructions for your operating system -* `arm-none-eabi-binutils` for assembling and linking - * Windows: [GNU Arm Embedded Toolchain](https://developer.arm.com/tools-and-software/open-source-software/developer-tools/gnu-toolchain/gnu-rm/downloads). - Make sure you select "Add path to environment variable" during the install - * Debian and derivatives (e.g. Ubuntu, raspberry pi OS, linux mint): `sudo apt install binutils-arm-none-eabi` - * Arch linux and derivatives: `sudo pacman -S arm-none-eabi-binutils` You will also want to install an emulator. The best support in agb is with [mgba](https://mgba.io), with `println!` support via `agb::println!` but any emulator should work. You'll get the best experience if