thedesk/README.md

53 lines
1.5 KiB
Markdown

<img src="readme/splash.svg" width="100%" />
---
<p align="center">
<img src="https://img.shields.io/github/v/release/vicr123/thedesk?label=LATEST&style=for-the-badge">
<img src="https://img.shields.io/github/license/vicr123/thedesk?style=for-the-badge" />
</p>
theDesk is a desktop environment built on Qt libraries.
---
<p align="center">
<img src="readme/screenshots/thedesk.png" width=45% /> <img src="readme/screenshots/overview.png" width=45% /><br>
<img src="readme/screenshots/desktops.png" width=45% /> <img src="readme/screenshots/thegateway.png" width=45% /><br>
<img src="readme/videos/desktops.gif" width=90% />
</p>
# Dependencies
- Qt 5
- Qt Core
- Qt GUI
- Qt Widgets
- Qt SVG
- [the-libs](https://github.com/vicr123/the-libs)
- [libtdesktopenvironment](https://github.com/vicr123/libtdesktopenvironment)
- Xlib
- xorg-libinput
- NetworkManager-Qt
## Recommended Dependencies
- [contemporary-widgets](https://github.com/vicr123/contemporary-widgets) - the default widget theme
- [contemporary-icons](https://github.com/vicr123/contemporary-icons) - the default icon theme
## Build
Run the following commands in your terminal.
```
mkdir build
qmake ../theDesk.pro
make
```
## Install
On Linux, run the following command in your terminal (with superuser permissions)
```
make install
```
---
> © Victor Tran, 2021. This project is licensed under the GNU General Public License, version 3, or at your option, any later version.
>
> Check the [LICENSE](LICENSE) file for more information.