Skip to content

Commit 0926c7f

Browse files
committed
docs: update README.md to reflect project name change and enhance feature descriptions
1 parent 9891794 commit 0926c7f

1 file changed

Lines changed: 85 additions & 24 deletions

File tree

README.md

Lines changed: 85 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,106 @@
1-
## 🚀 ***Task Core Optimizer (Magisk Module)***
2-
**Open Source Project:Android performance optmizer! Inspired By [Uperf](https://github.com/yc9559/uperf)**
1+
# CoreTaskOptimizer
32

4-
- Task-Core-Optimizer is a system performance optimizer by prioritizing critical tasks on high-performance CPU cores, adjusting process priorities, and managing CPU affinities.
5-
6-
[![License](https://img.shields.io/github/license/c0d3h01/TaskCoreOptimizer?style=for-the-badge)](LICENSE)
7-
[![Stars](https://img.shields.io/github/stars/c0d3h01/TaskCoreOptimizer?style=for-the-badge)](https://github.com/c0d3h01/TaskCoreOptimizer/stargazers)
3+
Adaptive core CPU optimizer for Android, designed for use as a [Magisk](https://github.com/topjohnwu/Magisk) module.
4+
This project provides a universal, cross-architecture binary for efficient task management, core affinity, and log management on rooted Android devices.
85

96
---
107

8+
## Features
9+
10+
- **Universal ABI Support**: Automatically builds for `arm64-v8a`, `armeabi-v7a`, `x86`, and `x86_64` (Android NDK supported).
11+
- **Magisk Module Ready**: Place binaries in the `libs/$ABI/task_optimizer` path for direct use in Magisk modules.
12+
- **CMake-based Build**: Simple and portable build process for Android and Linux environments.
13+
- **Automatic CI/CD**: GitHub Actions workflow automatically rebuilds and deploys binaries on changes to `src/main.cpp`.
14+
- **Customizable Service**: Comes with service scripts and configuration files for advanced users.
15+
16+
---
1117

12-
## **Features**
18+
## Directory Structure
1319

1420
```
15-
- High-Performance Core Assignment: Critical tasks are dynamically assigned to the most powerful CPU cores.
16-
- Process Prioritization: Automatically adjusts process priorities to boost system responsiveness.
17-
- CPU Affinity Management: Distributes tasks effectively across CPU cores for maximum performance.
18-
- Magisk-Compatible: Seamlessly integrates with the Android system via Magisk for system-level enhancements.
19-
- Written in C++: Fast and efficient execution, built for performance!
21+
.
22+
├── .github/ # GitHub Actions workflows
23+
├── common/ # Common headers/scripts (if any)
24+
├── libs/ # Output: ABI-specific binaries (e.g., libs/arm64-v8a/task_optimizer)
25+
├── src/ # Source code (main.cpp, etc.)
26+
├── CMakeLists.txt # CMake build script
27+
├── build.sh # Optional build helper script
28+
├── customize.sh # Customization script
29+
├── service.sh # Service starter script
30+
├── uninstall.sh # Uninstall helper script
31+
├── module.prop # Magisk module property file
32+
├── LICENSE # License file (MIT)
33+
└── README.md
2034
```
2135

2236
---
2337

24-
## **Installation**
38+
## Building
39+
40+
### Prerequisites
2541

26-
### Steps:
42+
- [Android NDK](https://developer.android.com/ndk/downloads)
43+
- [CMake](https://cmake.org/download/)
44+
- A POSIX-compatible shell (Linux/macOS/WSL)
2745

28-
1. **Download the Module**
29-
Download the latest release of the Task-Core-Optimizer Magisk module from the [Releases](https://github.com/c0d3h01/TaskCoreOptimizer/releases) section.
46+
### Build Manually
3047

31-
2. **Open Magisk Manager**
32-
Launch the Magisk Manager app on your rooted Android device.
48+
```sh
49+
# For a specific ABI:
50+
ABI=arm64-v8a
51+
mkdir -p build/$ABI
52+
cd build/$ABI
53+
cmake -DCMAKE_TOOLCHAIN_FILE=$ANDROID_NDK/build/cmake/android.toolchain.cmake \
54+
-DANDROID_ABI=$ABI \
55+
-DANDROID_PLATFORM=android-21 \
56+
../..
57+
cmake --build .
58+
cd ../..
59+
# Output: libs/$ABI/task_optimizer
60+
```
3361

34-
3. **Install the Module**
35-
In the Magisk Manager app, tap on `Modules`, then click on the `Install from Storage` button. Navigate to the downloaded `.zip` file and select it.
62+
Or use the provided workflow/build scripts to automate all ABIs.
3663

37-
4. **Reboot Your Device**
38-
Once the module is installed, reboot your device to apply the optimizations.
3964
---
4065

41-
## **License**
66+
## Continuous Integration
4267

43-
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more information.
68+
- **GitHub Actions**:
69+
On changes to `src/main.cpp`, the workflow will:
70+
1. Build for all ABIs.
71+
2. Copy binaries to `libs/$ABI/task_optimizer`.
72+
3. Upload `libs/` as an artifact for easy download.
4473

4574
---
75+
76+
## Usage in Magisk Module
77+
78+
Copy the ABI-specific binaries from `libs/` into your Magisk module under the appropriate path (e.g. `system/bin` or similar as required by your module).
79+
80+
Example:
81+
```
82+
libs/arm64-v8a/task_optimizer # For 64-bit ARM
83+
libs/armeabi-v7a/task_optimizer # For 32-bit ARM
84+
libs/x86/task_optimizer # For x86
85+
libs/x86_64/task_optimizer # For x86_64
86+
```
87+
88+
---
89+
90+
## License
91+
92+
This project is licensed under the [MIT License](LICENSE).
93+
94+
---
95+
96+
## Contributing
97+
98+
Pull requests and issues are welcome!
99+
Please use [issues](https://github.com/c0d3h01/CoreTaskOptimizer/issues) for bug reports or feature requests.
100+
101+
---
102+
103+
## Author
104+
105+
**Harshal Sawant**
106+
[GitHub](https://github.com/c0d3h01) | [Buy me a coffee](https://www.buymeacoffee.com/c0d3h01)

0 commit comments

Comments
 (0)