From 554e7ab26941175986ce29bb4aa0079aee379c3c Mon Sep 17 00:00:00 2001 From: Marco Salazar Date: Sat, 9 Oct 2021 18:46:47 +0000 Subject: [PATCH] Update 'README.md' --- README.md | 32 +++++++++++++++++++++++++------- 1 file changed, 25 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index f56e643..d9b9150 100644 --- a/README.md +++ b/README.md @@ -4,13 +4,31 @@ An infitite runner game powered by Firo. ## Getting Started -This project is a starting point for a Flutter application. +To build follow tutorials on setting up a flutter development enviornment. -A few resources to get you started if this is your first Flutter project: +Once you can build a default flutter application, you should be able to build the program. -- [Lab: Write your first Flutter app](https://flutter.dev/docs/get-started/codelab) -- [Cookbook: Useful Flutter samples](https://flutter.dev/docs/cookbook) +Simply git clone this repository, and open it up in an editor of your choice whether Android Studio or Visual Code, and if you have flutter and Dart plugins installed you should be able to build for any device. -For help getting started with Flutter, view our -[online documentation](https://flutter.dev/docs), which offers tutorials, -samples, guidance on mobile development, and a full API reference. +If solely using the command line +1) set up your flutter development enviornment +2) git clone the repository +3) go into repository with terminal +4) type: flutter pub get +5) type depending on what device you are building for: +``` +flutter build apk --bundle-sksl-path flutter_01.sksl.json --release +// or +flutter build web --web-renderer canvaskit --release +``` + +To connect to the server in tournament mode, set the variables in main.dart to the correct values of the server +``` +const SERVER = "http://serveripaddress"; +const PORT = "portnumber"; +``` + +If you are not interested in playing in tournament mode, simply set the following variable to true in main.dart +``` +const NO_TOURNAMENT = true; +``` \ No newline at end of file