diff --git a/README.md b/README.md index 131cd521..e20985c0 100644 --- a/README.md +++ b/README.md @@ -8,48 +8,58 @@ ## 🌟 Overview -Ubo App is a Python application for managing Raspberry Pi utilities and UBo-specific +Ubo App is a Python application for managing Raspberry Pi utilities and Ubo-specific features. +Ubo ai pod photo + +Example screenshots: + +Ubo ai pod photo + + + ## 🚧 Disclaimer Be aware that at the moment, Ubo app sends crash reports to Sentry. Soon we will limit this to beta versions only. -## ⚙️ Features +## ⚙️ Notable Features -[To be written] +- Headless WiFi on-boarding with QR Code +- Easy headless remote access with SSH and VS Code tunnel +- Install and run Docker apps headlessly +- Access and control basic RPi utilities and settings ## 📋 Requirements -These things are already taken care of in the official Ubo Pod image, so if you are -botting from that image, you can ignore this section. +Ubo app is developed to run on Raspberry Pi 4 and 5. The experience is optimized around Ubo Pod which offers -- Python 3.9 or later. -- Run `raspi-config` -> Interface Options -> Enable SPI +- a minimal LCD display and GUI with a keypad +- stereo microphone and speakers, +- camera +- LED ring +- sensors + +The app functions even if some of these hardware elements are not provided, however some of the features that relay on these hardware component may not function. For example, WiFi onboarding with QRcode requires a camera onboard. ## 📦 Installation -Note that as part of the installation process, these debian packages are installed: +### Pre-packaged image +Ubo Pod ships with a pre-flashed MicroSD card that has the app installed on it by default. -- git -- i2c-tools -- libcap-dev -- libegl1 -- libgl1 -- libmtdev1 -- libzbar0 -- python3-alsaaudio -- python3-dev -- python3-gpiozero -- python3-libcamera -- python3-picamera2 -- python3-pip -- python3-pyaudio -- python3-virtualenv +If you don't have it, or you just want to set up a fresh device, then: -Also be aware that ubo-app only installs in `/opt/ubo` and it is not customizable -at the moment. +1. download one of the images from the release section +2. Use Raspberry Pi Images and choose `custom image` to provide the download image file. +3. Write to the image +4. Use the image to boot your Ubo Pod or Raspberry Pi + +This is the fastest, easiest, and recommended way to get started with Ubo App. + +### Install on existing OS + +If you want to install the image on an existing operating system, then read on. Otherwise, skip this section. --- @@ -85,6 +95,26 @@ curl -sSL https://raw.githubusercontent.com/ubopod/ubo-app/main/ubo_app/system/i curl -sSL https://raw.githubusercontent.com/ubopod/ubo-app/main/ubo_app/system/install.sh\ | sudo ALPHA=true WITH_DOCKER=true bash ``` +Note that as part of the installation process, these debian packages are installed: + +- git +- i2c-tools +- libcap-dev +- libegl1 +- libgl1 +- libmtdev1 +- libzbar0 +- python3-alsaaudio +- python3-dev +- python3-gpiozero +- python3-libcamera +- python3-picamera2 +- python3-pip +- python3-pyaudio +- python3-virtualenv + +Also be aware that ubo-app only installs in `/opt/ubo` and it is not customizable +at the moment. ## 🤝 Contributing