Skip to content

Commit

Permalink
Update README file
Browse files Browse the repository at this point in the history
  • Loading branch information
penk committed Jan 22, 2020
1 parent 6263d63 commit f9b3014
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 2 deletions.
39 changes: 37 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,37 @@
# cutiepi-shell
A mobile UI for Raspberry Pi and Raspbian OS
## CutiePi shell

A mobile UI for Raspberry Pi and Raspbian OS.

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

CutiePi shell is built for the open source [CutiePi tablet](https://cutiepi.io) project.

## Features

* Lockscreen with sleep/wake button
* Built-in web browser, terminal emulator, and on-screen keyboard
* Side-tab layout for multitasking
* WiFi configuraton
* Battery charging status and level reading (through STM32 MCU)
* Orientation sensor support

Cutiepi shell is written entirely in Qt, and can be ported to Wayland or any platform with EGL support.

## Dependencies

- [Qt](http://download.qt.io/official_releases/qt/5.12/) `5.12.5`
- [Yat](https://github.com/jorgen/yat) for terminal emulator
- [libconnman-qt](https://git.sailfishos.org/mer-core/libconnman-qt) and [ConnMan](https://01.org/connman) `1.37` for WiFi configurator
- [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
- [QtMpu6050](https://github.com/cutiepi-io/QtMpu6050) QtSensors plugin

## Licensing

Icon assets are from `gnome-user-docs` package with following license and copyright information:

Copyright: Copyright (C) 2010 - 2014 Shaun McCance
License: CC-BY-3.0

* This project also used [Font Awesome](https://fontawesome.com/license/free) fonts, which is licensed under `SIL OFL 1.1 License`.
* CutiePi shell source code are licensed under the terms of the GNU General Public License version 3 or, at your option, any later version.
* And all documentation is licensed under a Creative Commons BY-SA 4.0 international license.
Binary file added cutiepi-shell-heroshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit f9b3014

Please sign in to comment.