From 1027e9ae5422fd86ec992381ef963ae664eb8e02 Mon Sep 17 00:00:00 2001 From: xAlpharax <42233094+xAlpharax@users.noreply.github.com> Date: Wed, 20 Sep 2023 22:04:49 +0300 Subject: Added proper description and instructions. --- README.md | 21 +++++++++------------ 1 file changed, 9 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 876a176..7285397 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,13 @@ -# ocr +# OCR-Flutter -A new Flutter project. +A fully functional Flutter aplication dedicated to Optical Character Recognition (OCR). -## Getting Started +This repo is part of my entry at EUCYS 2023. -This project is a starting point for a Flutter application. +## Insructions -A few resources to get you started if this is your first Flutter project: - -- [Lab: Write your first Flutter app](https://docs.flutter.dev/get-started/codelab) -- [Cookbook: Useful Flutter samples](https://docs.flutter.dev/cookbook) - -For help getting started with Flutter development, view the -[online documentation](https://docs.flutter.dev/), which offers tutorials, -samples, guidance on mobile development, and a full API reference. +1. Make sure to have the Flutter SDK installed and pointed at by your IDE. +2. Open the repository inside of the IDE, go to pubspec.yaml and perform `pub get` +3. Select the device to run the application on. Hit Run. +4. ??? +5. Profit. -- cgit v1.2.3