readme & license

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).