From efa74e2207b9b5789b4b5cb428e70658ad03360c Mon Sep 17 00:00:00 2001 From: Rumperuu Date: Wed, 29 Jul 2020 15:11:33 +0100 Subject: [PATCH] Update README.md --- README.md | 19 ++++++++++++++++--- 1 file changed, 16 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 4ba1702..e905cd0 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,18 @@ -# local_spend +# LocalSpend Mobile App. -Local Spend Tracker +This repo. contains the mobile application for use with the LocalSpend system, +using Flutter. ## Getting Started -This project is a starting point for a Flutter application. +Follow these steps to get the project up-and-running: + +1. Install [Flutter](https://flutter.dev/docs/get-started/install) +1. Set up [your editor](https://flutter.dev/docs/get-started/editor) + 1. If this is your first Flutter project, install the [Flutter SDK](https://flutter.dev/docs/get-started/test-drive) +1. Add the line `flutter.sdk=⟨ path to Flutter SDK ⟩` to the file `androud/local.properties` + +## Further Reading A few resources to get you started if this is your first Flutter project: @@ -14,3 +22,8 @@ A few resources to get you started if this is your first Flutter project: For help getting started with Flutter, view our [online documentation](https://flutter.io/docs), which offers tutorials, samples, guidance on mobile development, and a full API reference. + +Related repos: + +- [`Pear-Trading/FoodLoop-Web`](https://github.com/Pear-Trading/FoodLoop-Web) +- [`Pear-Trading/Foodloop-Server`](https://github.com/Pear-Trading/Foodloop-Server)