# cutiepi-shell

**Repository Path**: SunnyGeGe/cutiepi-shell

## Basic Information

- **Project Name**: cutiepi-shell
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: GPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-12-29
- **Last Updated**: 2023-12-29

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

## CutiePi shell

A mobile UI for Raspberry Pi OS.

![](screenshots/cutiepi-shell-heroshot.png)

CutiePi shell is a mobile UI built for [CutiePi tablet](https://cutiepi.io) project. Check out the [demo video](https://www.youtube.com/watch?v=ivkR3tvci1Q) 

## Features

* Lockscreen with sleep/wake button events handling 
* Web browser, terminal emulator, and on-screen keyboard 
* Built-in adblocker, using ABP-compatible filters 
* Side-tab for multitasking 
* WiFi configurator 
* Battery charging status and level reading (through UART) 
* Orientation sensor support (accelerometer and gyroscope) 

Cutiepi shell is written entirely in Qt using EGLFS QPA, and can be ported to [Wayland](https://github.com/cutiepi-io/cutiepi-shell/tree/wayland) or other platform and distributions with EGL support.

### Screenshots 

| ![](screenshots/sidetab.png) | ![](screenshots/wifi.png) |
| ------------- | ------------- | 
| ![](screenshots/terminal.png)  | ![](screenshots/settings.png) |

## Dependencies 

- [Qt](http://download.qt.io/official_releases/qt/5.12/) `5.12` or later version 
- [Yat](https://github.com/jorgen/yat) for terminal emulator 
- [nemo-qml-plugin-dbus](https://github.com/sailfishos/nemo-qml-plugin-dbus.git) for DBus signals 
- [libconnman-qt](https://git.sailfishos.org/mer-core/libconnman-qt) and [ConnMan](https://01.org/connman) for WiFi configuration 
- [CutiePi firmware](https://github.com/cutiepi-io/cutiepi-firmware) and [middleware plugins](https://github.com/cutiepi-io/cutiepi-middleware) for battery and sleep/wake button related functions 
- [ad-block](https://github.com/brave/ad-block) and [easylist](https://easylist.to/easylist/easylist.txt) for adblocker (optional) 

## License 

* CutiePi shell sources are licensed under the terms of the GNU General Public License version 3 or, at your option, any later version. 
* And all documentations are licensed under a Creative Commons BY-SA 4.0 international license. 
* This project uses [Font Awesome](https://fontawesome.com/license/free) fonts, which is licensed under `SIL OFL 1.1 License`. 

* Icons are from the `gnome-user-docs` package with following copyright information `Copyright: Copyright (C) 2010 - 2014 Shaun McCance`, and licensed under `CC-BY-3.0`. 
* Wallpapers are designed by [Even Wu](https://twitter.com/evenwu1978) licensed under CC-BY