From 446fc6ac52a59608a2f187e5c7cbec724f91d0f5 Mon Sep 17 00:00:00 2001 From: Aruki Date: Tue, 18 Dec 2018 17:52:57 -0700 Subject: [PATCH] Added build requirements to readme --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index eeed1650..ec280bc3 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,11 @@ # Prime World Editor +Prime World Editor is a custom editor suite for Retro Studios' GameCube and Wii games, including the Metroid Prime series and Donkey Kong Country Returns. -PROPER README TODO \ No newline at end of file +# Build Requirements +* Qt Creator +* Qt 5.10 installation +* LLVM 6.0.1 installation; currently must be installed to `C:\Program Files\LLVM\` +* Python 3+ +* Python packages `clang` and `mako` + +Most of the project code is cross-platform, but currently has only been tested on Windows, and parts of the build process most likely will not work correctly on other platforms.