43 lines
838 B
Markdown
43 lines
838 B
Markdown
# Nostalgia
|
|
|
|
## Prerequisites
|
|
|
|
* Install GCC, Clang, or Visual Studio with C++17 support (including std::filesystem)
|
|
* Install [devkitPro](https://devkitpro.org/wiki/Getting_Started) to build for GBA
|
|
* Install Python 3
|
|
* Install Ninja, Make, and CMake
|
|
* Ensure you have prerequisites for vcpkg (curl, zip, unzip)
|
|
* Consider also installing ccache for faster subsequent build times
|
|
|
|
## Platform Specific Setup
|
|
|
|
### macOS
|
|
|
|
Install and use gmake instead of the make that comes with the system.
|
|
|
|
## Build
|
|
|
|
Build options: release, debug, asan, gba, gba-debug
|
|
|
|
make setup-conan
|
|
make purge conan configure-{gba,release,debug} install
|
|
|
|
## Run
|
|
|
|
### Studio
|
|
|
|
make run-studio
|
|
|
|
### Native Platform
|
|
|
|
make run
|
|
|
|
### GBA
|
|
|
|
make gba-run
|
|
|
|
## Contributing
|
|
|
|
Please read the [Developer Handbook](developer-handbook.md) for information on
|
|
coding standards.
|