diff --git a/README.md b/README.md index 14e050b..d799c82 100644 --- a/README.md +++ b/README.md @@ -7,3 +7,27 @@ A fully featured NBT Editor - NBT - SNBT - GUI + +## Build + +The following is the build instructions for this project. + +# Linux + +1. Install Flutter and add it to your path. +2. Run the command: `flutter build linux` + +# Windows + +1. Install Flutter and add it to your path. +2. Run the command: `flutter build windows` + +# MacOS + +1. Install Flutter and add it to your path. +2. Install XCode +3. Install any necessary command line developer tools from XCode +4. Developer mode? +5. Run the command? `flutter build mac` or `flutter build macos` + +**Testing needed** I do not own a Mac, testing by a Mac user will be required.