Initial commit: build env for the Ubtouch OS
Change-Id: I4bf8c32811d2785bd86a532f4cb435794f5c14d2
This commit is contained in:
commit
efb4feb07b
9 changed files with 740 additions and 0 deletions
88
README.md
Normal file
88
README.md
Normal file
|
@ -0,0 +1,88 @@
|
|||
# How to Build UbtouchOS with Docker
|
||||
|
||||
## Why Docker?
|
||||
|
||||
Using Docker ensures all required dependencies are pre-installed and properly configured.
|
||||
You don’t need to install complex toolchains or modify your host system.
|
||||
|
||||
---
|
||||
|
||||
## Requirements
|
||||
|
||||
### Software
|
||||
|
||||
- **Docker**
|
||||
Install Docker using the official script:
|
||||
```bash
|
||||
curl -fsSL https://get.docker.com | sh
|
||||
```
|
||||
|
||||
- **Git**
|
||||
[Install Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
|
||||
|
||||
- **Repo tool**
|
||||
Install the Google `repo` tool:
|
||||
|
||||
```bash
|
||||
mkdir -p ~/bin
|
||||
curl https://storage.googleapis.com/git-repo-downloads/repo > ~/bin/repo
|
||||
chmod a+x ~/bin/repo
|
||||
export PATH=~/bin:$PATH
|
||||
```
|
||||
|
||||
### Hardware
|
||||
|
||||
- **Disk:** \~30 GB (source code and build artifacts). SSD recommended
|
||||
|
||||
- **CPU:** 64-bit processor (Intel i5/i7 or AMD Ryzen 5/7 and above recommended, 8 cores or more preferred)
|
||||
|
||||
- **Memory:**
|
||||
|
||||
* Minimum: 16 GB RAM
|
||||
* Bare minimum: 8 GB RAM (with swap; builds will be very slow and unstable)
|
||||
|
||||
---
|
||||
|
||||
## Usage
|
||||
|
||||
1. **Clone this repo** to your local machine and navigate into it:
|
||||
|
||||
```bash
|
||||
git clone https://git.os-source.co/UbuntuTouchOs/build.git
|
||||
cd build
|
||||
```
|
||||
|
||||
2. **Clone the brax3 ubports** into the `UbuntuTouchOs/build` checkout directory:
|
||||
|
||||
```bash
|
||||
git clone https://git.os-source.co/UbuntuTouchOs/brax3-ubports brax3
|
||||
```
|
||||
|
||||
3. **Start the build with Docker**:
|
||||
|
||||
```bash
|
||||
docker compose up -d
|
||||
```
|
||||
|
||||
4. **Check the build logs and wait**:
|
||||
|
||||
```bash
|
||||
docker logs -f repo_build_ubtouch
|
||||
```
|
||||
|
||||
5. Once the "success message" appears in the logs (this typically takes 10-30 minutes, depending on your hardware,
|
||||
navigate to the brax3/out folder to find your fastboot images:
|
||||
|
||||
```bash
|
||||
ls -la brax3/out | grep ubuntu.img
|
||||
-rw-r--r-- 1 root root 1433058439 Sep 23 16:50 ubuntu.img
|
||||
```
|
||||
|
||||
6. After building, follow the flashing instructions in [HOW_TO_FLASH.md](HOW_TO_FLASH.md) to install the images onto your phone.
|
||||
|
||||
---
|
||||
|
||||
## Licensing
|
||||
|
||||
LunarOS/build is licensed under the **Apache License, Version 2.0**.
|
||||
See [LICENSE](LICENSE) for the full license text.
|
Loading…
Add table
Add a link
Reference in a new issue