Merge branch 'main' of github.com:cutefishos/uikit

README.md

@@ -1,5 +1,19 @@
 # FishUI
 
+FishUI is a GUI library based on QQC2 (Qt Quick Controls 2), every Cutefish application uses it.
+
+## Features
+
+* Light and Dark Mode
+* Borderless window (XCB Window move & resize)
+* Blurred window
+* Window shadow
+* Desktop-level menu
+* The style of the Qt Quick control
+* ...
+
+## Dependencies
+
 ```bash
 sudo apt install libqt5x11extras5-dev libkf5windowsystem-dev -y
 ```
@@ -11,4 +25,8 @@ Before build, make sure you have necessary Qt environment.
 cmake -DCMAKE_INSTALL_PREFIX:PATH=/usr ..
 make
 sudo make install
-```
+```
+
+## License
+
+FishUI is licensed under GPLv3.