update: README.md with more info

This commit updates the README.md to contain more info about the existence of the project and Rust libraries used.
This commit is contained in:
ThePedroo
2024-06-26 19:43:38 -03:00
parent af96b85a91
commit 51507e8627

View File

@@ -1,23 +1,47 @@
# ReZygisk # ReZygisk
ReZygisk is a fork of Zygisk Next by Dr-TSNG, which is a standalone implementation of Zygisk, providing Zygisk API support for KernelSU, Magisk and APatch. ReZygisk is a fork of Zygisk Next, which is a standalone implementation of Zygisk, providing Zygisk API support for KernelSU, Magisk (besides built-in) and futurely APatch.
It aims at the re-write of Zygisk Next to C, allowing also a more efficient and faster implementation of the Zygisk API with a more permissive license. It aims at the modernization and re-write of the codebase to C (from C++ and Rust), allowing a more efficient and faster implementation of the Zygisk API with a more permissive license.
> [!NOTE] > [!NOTE]
> This module/fork is WIP, only use .zip from the releases. > This module/fork is WIP, only use .zip from the releases.
## Why?
The latest releases of Zygisk NExt are not open-source, reserving entirely the code for its developers. Not only that limits our ability to contribute to the project, but also impossibilitates the audit of the code, which is a major concern for security, as Zygisk Next is a module that runs with superuser (root) privileges, having access to the entire system.
The Zygisk Next developers are famous and trusted in the Android community, however this doesn't mean that the code is not malicious or vulnerable. We (PerformanC) understand they have their reasons to keep the code closed-source, but we believe that contrary.
## Features ## Features
- Open Source - FOSS (forever)
- Better hiding standalone
## Dependencies ## Dependencies
- rust - rustc
- Android NDK
### Rust-side: ### Rust side:
- - android_logger
- anyhow
- bitflags
- const_format
- futures
- konst
- lazy_static
- libc
- log
- memfd
- num_enum
- passfd
- proc-maps
### C++ side:
- lsplt
## Installation ## Installation
@@ -37,4 +61,4 @@ It is mandatory to follow the PerformanC's [contribution guidelines](https://git
## License ## License
ReZygisk is licensed majoritaly under GPL, by Dr-TSNG, but also BSD 2-Clause License. You can read more about it on [Open Source Initiative](https://opensource.org/licenses/BSD-2-Clause). ReZygisk is licensed majoritaly under GPL, by Dr-TSNG, but also BSD 2-Clause License for re-written code. You can read more about it on [Open Source Initiative](https://opensource.org/licenses/BSD-2-Clause).