README>md: initial

README.md

@@ -1,16 +1,64 @@
-# app
+# Sudoku
 
-A new Flutter project.
+An beautiful and customizable sudoku app made in flutter by Pedro Kalil.
 
-## Getting Started
+## Packages used
 
-This project is a starting point for a Flutter application.
+Most packages are made by me and form an cohesive ecosystem for programming in a
+reactive/functional style without mutation and with rich ui elements that adapt
+to the user's wallpaper following the Material You design language
 
-A few resources to get you started if this is your first Flutter project:
+- [libsudoku](https://www.github.com/kalildev/libsudoku), made in C for the best
+  performance by me, and used in the app using dart:ffi.
+- [utils](https://www.github.com/kalildev/utils), made by me.
+- [value_notifier](https://www.github.com/kalildev/value_notifier), made by me.
+- [hive](https://pub.dev/packages/hive), which i contributed to by migrating to
+  NNDB and adding built_value support.
+- [synchronized](https://pub.dev/packages/synchronized).
+- [material_widgets](https://www.github.com/kalildev/material_widgets), made by
+  me, which in turn uses.
+  * [palette_from_wallpaper](https://github.com/KalilDev/palette_from_wallpaper)
+  , made by me.
+  * [material_you](https://github.com/KalilDev/material_you), made by me.
+  * [flutter_monet_theme](https://github.com/KalilDev/monet_theme), made by me.
+  * [monet_theme](https://github.com/KalilDev/monet_theme), made by me.
+- [path_provider](https://pub.dev/packages/path_provider).
+- [sudoku_core](https://github.com/KalilDev/sudoku/tree/old/sudoku_core), made
+  by me for the previous sudoku app game.
+- [adt_generator](https://github.com/KalilDev/adt_generator), made by me,and
+  also
+  * [adt_annotation](https://github.com/KalilDev/adt_generator)
+- [flutter_colorpicker](https://pub.dev/packages/flutter_colorpicker).
+- [google_fonts](https://pub.dev/packages/google_fonts).
 
-- [Lab: Write your first Flutter app](https://flutter.dev/docs/get-started/codelab)
-- [Cookbook: Useful Flutter samples](https://flutter.dev/docs/cookbook)
+## Architecture
 
-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.
+The details of the how's and why's of this app's are available in
+[architecture.md](architecture.md)
+
+## Screenshots
+
+### Light
+<img src="readme-assets/screenshots/light/1.png" height="480"></img>
+<img src="readme-assets/screenshots/light/2.png" height="480"></img>
+<img src="readme-assets/screenshots/light/3.png" height="480"></img>
+<img src="readme-assets/screenshots/light/4.png" height="480"></img>
+<img src="readme-assets/screenshots/light/5.png" width="480"></img>
+<img src="readme-assets/screenshots/light/6.png" width="480"></img>
+
+### Dark
+<img src="readme-assets/screenshots/dark/1.png" height="480"></img>
+<img src="readme-assets/screenshots/dark/2.png" height="480"></img>
+<img src="readme-assets/screenshots/dark/3.png" height="480"></img>
+<img src="readme-assets/screenshots/dark/4.png" height="480"></img>
+<img src="readme-assets/screenshots/dark/5.png" width="480"></img>
+<img src="readme-assets/screenshots/dark/6.png" width="480"></img>
+
+## Running the app
+
+Android apks are available at the
+[releases page](https://github.com/KalilDev/sudoku/releases), and will soon be
+uploaded to the Play Store.
+
+The app is also acessible on the
+[website](https://kalildev.github.io/sudoku/index.html), although it is slower.