Skip to content

Latest commit

 

History

History
90 lines (62 loc) · 7.81 KB

README.md

File metadata and controls

90 lines (62 loc) · 7.81 KB
Raw

UBports Installer Continuous Integration snap codecov

Fear not! Installing UBports Ubuntu Touch on your device is easy! Just download the UBports Installer package for your operating system and sit back and relax while your computer does all the rest. Installing third-party operating systems has never been so easy!

linux logo   Linux mac logo   macOS windowslogo   Windows
snap
snap install ubports-installer
AppImage
deb		 dmg exe

Troubleshooting

Troubleshooting information can be found in the docs. If you need help, you can join UBports' support channels on telegram or matrix or ask a question in the forum or on askubuntu. If you believe that the UBports Installer is not working correctly, you can also file a new issue to help us solve the problem. Use the Report a bug button directly in the installer to generate a template for a bugreport with all the important metadata automatically filled out.

Config files

By default, the Installer will always use the latest version of the installation configuration files available. Should you want to specify a custom config file, you can do that by starting the Installer with the -f ./path/to/config.yml argument. This can be used to test changes to the configuration or even to add new devices to the installer. The structure of the config files is specified here.

Logs

If the installer runs into an error, it will usually present you with the option to create a bug report. It is always a good idea to make use of that feature, because that way the developers will almost always have all the information they need to help you. If you still have to look at the log file for some reason, you can find it in ~/.cache/ubports/ubports-installer.log on linux (or ~/snap/ubports-installer/current/.cache/ubports/ubports-installer.log if you're using the snap package). On Windows, it will be located at %APPDATA%\ubports\ubports-installer.log and on macOS you can find it under $HOME/Library/Caches/ubports/ubports-installer.log.

Set up for development

Currently our script will automatically install the toolchain for you on Arch, Ubuntu, OpenSUSE and other apt based distributions.

git clone https://github.com/ubports/ubports-installer.git
cd ubports-installer
./setup-dev.sh

Run with npm

$ npm start -- -h
Usage: npm start -- [-f <file>] [-v[v] [-d]

UBports Installer (0.7.2-beta) source for linux
GPL-3.0 UBports Foundation <[email protected]>
The easy way to install Ubuntu Touch on UBports devices. A friendly cross-platform Installer for Ubuntu Touch. Just connect a supported device to your PC, follow the on-screen instructions and watch this awesome tool do all the rest.
https://devices.ubuntu-touch.io

Options:
  -V, --version        output the version number
  -f, --file <file>    Override the official config by loading a YAML local file
  -v, --verbose        Print debugging information. Multiple -v options increase the verbosity
  -d, --debug          Enable electron's web debugger to inspect the frontend (default: false)
  --systemimage <url>  Set a custom systemimage server url (default:
                       "https://system-image.ubports.com/")
  -h, --help           display help for command

Lint

Before filing a PR, please make sure you follow our coding style by running npm run lint.

Build packages

$ ./build.js --help
Usage: ./build.js -o <os> -p <package> -a <arch> [options]

Options:
  -V, --version                output the version number
  -o, --os <os>                Target operating system (darwin, win32, linux) (default: "linux")
  -p, --package <package>      Target package (deb, snap, AppImage, dmg, portable, dir) (default: "dir")
  -a, --arch <architecture>    Target architecture (armv7l, x64, ia32, arm64) (default: "x64")
  -e, --extra-metadata [JSON]  extra data for package.json (default: "{}")
  -h, --help                   output usage information

Libraries

The UBports Foundation maintains a various free- and open-source NPM libraries for the UBports Installer.

Package Version Description
progressive-downloader version Parallel downloads and opportunistic checksum verification
promise-android-tools version Extensive wrapper for ADB, Fastboot, Heimdall
android-tools-bin version Cross-platform binaries for ADB, Fastboot, Heimdall
open-cuts-reporter version Report test results to UBports OPEN-CUTS

License

Original development by Marius Gripsgård and Johannah Sprinz. Copyright (C) 2017-2022 UBports Foundation.

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.