2016-03-15 00:07:52 -05:00
|
|
|
# Nostalgia
|
2017-04-19 01:22:07 -05:00
|
|
|
|
2020-06-30 12:18:44 -05:00
|
|
|
## Prerequisites
|
2017-04-19 01:22:07 -05:00
|
|
|
|
2022-02-04 23:48:27 -06:00
|
|
|
* Install GCC, Clang, or Visual Studio with C++20 support
|
2020-07-13 19:02:54 -05:00
|
|
|
* Install [devkitPro](https://devkitpro.org/wiki/Getting_Started) to build for GBA
|
2021-03-02 21:17:21 -06:00
|
|
|
* Install Python 3
|
2020-07-29 00:54:22 -05:00
|
|
|
* Install Ninja, Make, and CMake
|
|
|
|
* Consider also installing ccache for faster subsequent build times
|
2020-04-11 03:07:52 -05:00
|
|
|
|
2023-09-24 10:17:18 -05:00
|
|
|
### Debian
|
|
|
|
|
|
|
|
For Debian (and probably other Linux distros, but the package names will
|
|
|
|
probably differ), install the following additional packages:
|
|
|
|
* pkg-config
|
|
|
|
* xorg-dev
|
2023-12-09 23:20:12 -06:00
|
|
|
* libgtk-3-dev
|
2023-12-30 22:50:11 -06:00
|
|
|
* python3-mypy
|
2023-09-24 10:17:18 -05:00
|
|
|
|
2020-04-11 03:07:52 -05:00
|
|
|
## Build
|
|
|
|
|
2020-06-30 12:18:44 -05:00
|
|
|
Build options: release, debug, asan, gba, gba-debug
|
2017-04-19 01:22:07 -05:00
|
|
|
|
2022-03-24 00:58:38 -05:00
|
|
|
make purge configure-{gba,release,debug} install
|
2020-07-13 19:02:54 -05:00
|
|
|
|
|
|
|
## Run
|
|
|
|
|
|
|
|
### Studio
|
|
|
|
|
|
|
|
make run-studio
|
|
|
|
|
|
|
|
### Native Platform
|
|
|
|
|
|
|
|
make run
|
|
|
|
|
|
|
|
### GBA
|
|
|
|
|
|
|
|
make gba-run
|
2020-07-29 00:54:22 -05:00
|
|
|
|
|
|
|
## Contributing
|
|
|
|
|
|
|
|
Please read the [Developer Handbook](developer-handbook.md) for information on
|
|
|
|
coding standards.
|