update README
This commit is contained in:
parent
d444f35ed8
commit
211f289d8b
1 changed files with 85 additions and 2 deletions
87
README.md
87
README.md
|
|
@ -1,3 +1,86 @@
|
|||
# A-Team-Android_ROM_Builder
|
||||
# A-Team Android ROM Builder
|
||||
A GTK-based Android ROM build environment designed to simplify syncing, configuring, and compiling custom Android ROMs.
|
||||
|
||||
Built for Linux, the builder provides an organized interface for managing multiple ROM trees, devices, and build scripts without relying on lengthy terminal commands.
|
||||
|
||||
|
||||
## Features
|
||||
* Simple GTK Desktop Interface
|
||||
* Support For Multiple Android ROM Projects
|
||||
* Device-Specific Configuration Files
|
||||
* Embedded Terminal For Live Build Output
|
||||
* Resource Monitor For CPU, Memory, & System Usage
|
||||
* Automated Device Repository Syncing
|
||||
|
||||
|
||||
## Features - ADVANCED
|
||||
* Script Launcher For Common Development Tasks
|
||||
* Environment Variable Management
|
||||
* Easily Expandable Project Structure
|
||||
|
||||
|
||||
## Project Structure
|
||||
```text
|
||||
A-Team-Android_ROM_Builder/
|
||||
├── builder/ # Core application modules
|
||||
├── configs/ # Device and ROM configuration files
|
||||
├── scripts/ # Build and utility scripts
|
||||
├── gui.py # Application entry point
|
||||
└── README.md
|
||||
```
|
||||
|
||||
|
||||
## Requirements
|
||||
* Linux
|
||||
* Python 3
|
||||
* GTK 3
|
||||
* VTE 2.91
|
||||
* Git
|
||||
* Android build dependencies
|
||||
|
||||
|
||||
## Getting Started
|
||||
Clone the repository:
|
||||
```bash
|
||||
git clone https://ateam.gotadell.com/git/PizzaG/A-Team-Android_ROM_Builder.git
|
||||
cd A-Team-Android_ROM_Builder
|
||||
```
|
||||
|
||||
Launch the application:
|
||||
```bash
|
||||
python3 gui.py
|
||||
```
|
||||
|
||||
|
||||
## Configuration
|
||||
Device settings are stored in:
|
||||
```
|
||||
configs/<device>.conf
|
||||
```
|
||||
|
||||
ROM-wide settings are stored in:
|
||||
```
|
||||
configs/rom.conf
|
||||
```
|
||||
|
||||
The builder exports the required environment variables automatically before executing build scripts.
|
||||
|
||||
|
||||
## Goals
|
||||
The project is intended to provide a lightweight, modular Android ROM build environment that:
|
||||
|
||||
* Reduces repetitive setup tasks
|
||||
* Keeps device configurations organized
|
||||
* Makes switching between ROM projects simple
|
||||
* Provides a clean GUI while remaining script-driven
|
||||
* Stays easy to customize and extend
|
||||
|
||||
|
||||
## Contributing
|
||||
Contributions, bug reports, and feature suggestions are welcome. Feel free to open an issue or submit a pull request.
|
||||
|
||||
|
||||
## License
|
||||
Released under the GNU General Public License v3.0 (GPL-3.0).
|
||||
2019-Present --> A-Team Digital Solutions
|
||||
|
||||
Home of A-Team Android ROM Builder
|
||||
Loading…
Reference in a new issue