diff --git a/fbla_ui/README.md b/fbla_ui/README.md index 719ad9c..bccf6bd 100644 --- a/fbla_ui/README.md +++ b/fbla_ui/README.md @@ -6,6 +6,8 @@ My version of the app can be found at [marinodev.com/fbla/](https://marinodev.co Pre-built files for several operating systems (built with my API) can be found in the releases tab, alternatively, you can compile it yourself for use with your own API and database (see API readme): +### Windows/Linux + 1. Install [Flutter](https://docs.flutter.dev/get-started/install) 2. Use `flutter doctor` to make sure your environment is fully set up for your platform 3. Clone the repo @@ -18,3 +20,18 @@ cd FBLA24/fbla_ui/ 4. Run `flutter pub get` to install all dependencies 5. Optional: set `apiAddress` at the top of `lib/api_logic.dart` 6. Build app with `flutter build --release` + +### MacOS + +*These instructions are temporary and will change as I try MacOS* + +1. Install [Flutter](https://docs.flutter.dev/get-started/install) +2. Use `flutter doctor` to make sure your environment is fully set up for your platform +3. Clone the repo +``` +git clone https://git.marinodev.com/MarinoDev/FBLA24.git +cd FBLA24/fbla_ui/ +``` +4. Run `flutter pub get` to install all dependencies +5. Optional: set `apiAddress` at the top of `lib/api_logic.dart` +6. Build app with `flutter build --release`