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
|
|
|
|
2020-07-04 20:51:59 -05:00
|
|
|
* Install GCC, Clang, or Visual Studio with C++17 support (including std::filesystem)
|
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
|
2020-08-05 20:30:05 -05:00
|
|
|
* Ensure you have prerequisites for vcpkg (curl, zip, unzip)
|
2020-07-29 00:54:22 -05:00
|
|
|
* Consider also installing ccache for faster subsequent build times
|
2020-04-11 03:07:52 -05:00
|
|
|
|
2020-06-30 12:18:44 -05:00
|
|
|
## Platform Specific Setup
|
2020-04-11 03:07:52 -05:00
|
|
|
|
2017-04-19 01:22:07 -05:00
|
|
|
### macOS
|
|
|
|
|
|
2020-04-11 03:07:52 -05:00
|
|
|
Install and use gmake instead of the make that comes with the system.
|
|
|
|
|
|
|
|
|
|
## 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
|
|
|
|
2021-03-28 00:42:20 -05:00
|
|
|
make conan-config
|
2021-03-28 00:25:30 -05:00
|
|
|
make purge conan 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.
|
