vrr/Flocon
2
0
Fork 0
mirror of https://github.com/openflocon/Flocon.git synced 2026-06-24 00:49:11 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

removed theme
Some checks failed
docs / deploy (push) Has been cancelled
Details

Browse source
This commit is contained in:
Florent Champigny 2025-12-24 15:11:24 +01:00
parent 8240248534
commit db8b27c544
2 changed files with 20 additions and 32 deletions
Download patch file Download diff file Expand all files Collapse all files

20
docs/index.md
View file

@ -6,6 +6,10 @@ Inspired from [Flipper](https://github.com/facebook/flipper) by Meta, while leve
It allows developers to connect a Kotlin Multiplatform or Android app to their computer and launch a **desktop interface** that can **observe, inspect, and interact with the running app** in real time — across shared Kotlin code and platform-specific implementations.
<img width="1294" height="837" alt="Screenshot 2025-09-12 at 15 39 45" src="https://github.com/user-attachments/assets/3d585adb-6441-4cdb-ad25-69d771ad4ff6" />
----> [Getting Started](setup.md) <----
**Works on**
<table>
<thead>
@ -104,18 +108,4 @@ With Flocon, you gain deep access to critical app internals — such as
and more — without needing root access or tedious ADB commands.
It’s designed for modern multiplatform development, accelerating debugging, QA, and iteration cycles.
<img width="1294" height="837" alt="Screenshot 2025-09-12 at 15 39 45" src="https://github.com/user-attachments/assets/3d585adb-6441-4cdb-ad25-69d771ad4ff6" />
---
## 🚀 What Can Flocon Do?
Once your device (Android / iOS / Desktop) is connected and your app includes the Flocon SDK, you can use the desktop companion app to access the following features:
## ✨ Upcoming features
Flocon is still evolving, next features :
- Preview & Download files
It’s designed for modern multiplatform development, accelerating debugging, QA, and iteration cycles.

32
docs/setup.md
View file

@ -1,18 +1,5 @@
🛠️ Getting Started
## 🧰 Requirements
### for android
- An Android device with USB debugging enabled
- Android Studio or SDK tools installed
- ADB (Android Debug Bridge) accessible from your system path
### for all platforms
- Flocon Desktop app (JVM-based)
- Flocon SDK integrated into your app
- At least `kotlin 2.0.0` in your app
- Be aligned between the mobile library version & the desktop app version
## Installation
in your module .kts
@ -40,9 +27,20 @@ flocon = "LASTEST_VERSION"
flocon = { module = "io.github.openflocon:flocon", version.ref = "flocon" }
```
Download & install the last `Desktop client`
https://github.com/openflocon/Flocon/releases
Download & install the last [Desktop client](https://github.com/openflocon/Flocon/releases)
> [!NOTE]
> If you are on MacOS, you might need to follow specific instructions to open the app. See [MacOS Installation](macos-install.md).
> If you are on MacOS, you might need to follow specific instructions to open the app. See [MacOS Installation](macos-install.md).
## 🧰 Requirements
### for android
- An Android device with USB debugging enabled
- Android Studio or SDK tools installed
- ADB (Android Debug Bridge) accessible from your system path
### for all platforms
- Flocon Desktop app (JVM-based)
- Flocon SDK integrated into your app
- At least `kotlin 2.0.0` in your app
- Be aligned between the mobile library version & the desktop app version