From 74eb6e3d262a3c827e2981761d35fae2c5066650 Mon Sep 17 00:00:00 2001
From: Flummi <git@srv.fail>
Date: Mon, 9 Jun 2025 15:42:13 +0200
Subject: [PATCH] readme & license

---
 LICENSE   | 21 +++++++++++++++++++++
 README.md | 52 ++++++++++++++++++++++++++++++++++++++++++----------
 2 files changed, 63 insertions(+), 10 deletions(-)
 create mode 100644 LICENSE

diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..644bc3f
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 f0ck
+
+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.
diff --git a/README.md b/README.md
index 0946160..a5be79d 100644
--- a/README.md
+++ b/README.md
@@ -1,16 +1,48 @@
-# f0ckapp
+# fApp
+![f0ck.me Logo](https://git.lat/f0ck/fApp/raw/branch/master/android/app/src/main/res/mipmap-xhdpi/ic_launcher_foreground.png)
+## Overview
 
-A new Flutter project.
+fApp is the mobile application for the website [f0ck.me](https://f0ck.me). This app provides a user-friendly interface to access the content of the website and utilize its features conveniently from your mobile device.
 
-## Getting Started
+## Installation
 
-This project is a starting point for a Flutter application.
+fApp is available in its own F-Droid repository.
 
-A few resources to get you started if this is your first Flutter project:
+### Installation Steps
 
-- [Lab: Write your first Flutter app](https://docs.flutter.dev/get-started/codelab)
-- [Cookbook: Useful Flutter samples](https://docs.flutter.dev/cookbook)
+1. Add the F-Droid repository to your F-Droid app:
+   - Go to the settings in the F-Droid app.
+   - Select "Repositories" and add the URL `https://fdroid.flumm.io/fdroid/repo/`.
 
-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.
+2. Search for "f0ckapp" in the F-Droid app and install the app.
+
+## Development
+
+### Prerequisites
+
+- Flutter SDK
+- Dart SDK
+- Android Studio or Visual Studio Code
+
+### Setting Up the Project
+
+1. Clone the repository:
+   ```bash
+   git clone https://git.lat/f0ck/fApp.git
+   cd fApp
+2. Install dependencies:
+  ```flutter pub get```
+3. Run the app:
+  ```flutter run```
+
+### Contributing
+
+don't.
+
+### License
+
+This project is licensed under the MIT License. See the LICENSE file for more information.
+
+### Contact
+
+For questions or feedback, you can reach us at [contact@f0ck.me](mailto:contact@f0ck.me).