add readme and license

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Lukas Heiligenbrunner
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,16 +1,33 @@
-# notes
+# Notes
 
-A new Flutter project.
+A FOSS alternative for taking handwritten notes on Android.
+Note that this project is still in an early development stage and far away to be seen as stable.
+
+## Features
+
+* Paged view
+* saving to a file
+* deleting strokes
+* highlight with marker
+* export as pdf
 
 ## Getting Started
 
-This project is a starting point for a Flutter application.
+1) check out the project
 
-A few resources to get you started if this is your first Flutter project:
+`git clone https://gitlab.heili.eu/lukas/notes.git`
 
-- [Lab: Write your first Flutter app](https://docs.flutter.dev/get-started/codelab)
+2) get flutter dependencies
-- [Cookbook: Useful Flutter samples](https://docs.flutter.dev/cookbook)
 
-For help getting started with Flutter development, view the
+`flutter pub get`
-[online documentation](https://docs.flutter.dev/), which offers tutorials,
+
-samples, guidance on mobile development, and a full API reference.
+3) build apk
+
+`flutter build apk --target-platform android-arm64`
+
+now you have built your apk at `./build/app/outputs/apk/release/app-release.apk`
+
+
+## Contribution
+
+Any contribution is appreciated. Feel free to open an issue or a pull request if you found a bug.