You've already forked ReZygisk
mirror of
https://github.com/PerformanC/ReZygisk.git
synced 2025-09-06 06:37:01 +00:00
update: READMEs information; remove: outdated READMEs (#146)
This commit updates the information in ReZygisk "README.md" and its translations, and it also removes the ones that were not updated. Signed-off-by: Lucky Kiddos <95188840+GuitarHeroStyles@users.noreply.github.com> Signed-off-by: GhostFRR <ghost.game.fr@gmail.com> Signed-off-by: Alice w/🌧️ <rainyxeon@gmail.com> Co-authored-by: GhostFRR <ghost.game.fr@gmail.com> Co-authored-by: Lucky Kiddos <95188840+GuitarHeroStyles@users.noreply.github.com> Co-authored-by: Alice w/🌧️ <rainyxeon@gmail.com>
This commit is contained in:
46
README.md
46
README.md
@@ -1,15 +1,10 @@
|
||||
# ReZygisk
|
||||
|
||||
[简体中文](/READMEs/README_zh-CN.md)|[繁體中文](/READMEs/README_zh-TW.md)|[Bahasa Indonesia](/READMEs/README_id-ID.md)|[Tiếng Việt](/READMEs/README_vi-VN.md)|[Português Brasileiro](/READMEs/README_pt-BR.md)|[Türkçe](/READMEs/README_tr-TR.md)|[French](/READMEs/README_fr-FR.md)
|
||||
[Bahasa Indonesia](/READMEs/README_id-ID.md)|[Tiếng Việt](/READMEs/README_vi-VN.md)|[Português Brasileiro](/READMEs/README_pt-BR.md)|[French](/READMEs/README_fr-FR.md)
|
||||
|
||||
ReZygisk is a fork of Zygisk Next, a standalone implementation of Zygisk, providing Zygisk API support for KernelSU, Magisk (besides built-in), and APatch (Work In Progress).
|
||||
ReZygisk is a fork of Zygisk Next, a standalone implementation of Zygisk, providing Zygisk API support for KernelSU, APatch and Magisk (Official and Kitsune).
|
||||
|
||||
It aims to modernize and re-write 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]
|
||||
> This module/fork is WIP (Work In Progress); only use .zip from the Releases.
|
||||
>
|
||||
> Although you may install the .zip from the [Actions](https://github.com/PerformanC/ReZygisk/actions) page, it is only at your discretion to install it since your device might enter bootloop.
|
||||
It aims to modernize and re-write the codebase to C entirely, allowing a more efficient and faster implementation of the Zygisk API with a more permissive, and FOSS friendly, license.
|
||||
|
||||
## Why?
|
||||
|
||||
@@ -33,24 +28,45 @@ The Zygisk Next developers are famous and trusted in the Android community, howe
|
||||
|------------|-------------------------------|
|
||||
| `lsplt` | Simple PLT Hook for Android |
|
||||
|
||||
## Usage
|
||||
|
||||
We're currently in the process of cooking. (Coming Soon)
|
||||
|
||||
## Installation
|
||||
|
||||
There are currently no available stable releases. (Coming Soon)
|
||||
### 1. Select the right zip
|
||||
|
||||
The selection of the build/zip is important, as it will determine how hidden and stable ReZygisk will be. This, however, is not a hard task:
|
||||
|
||||
- `release` should be the one chosen for most cases, it removes app-level logging and offers more optimized binaries.
|
||||
- `debug`, however, offers the opposite, with heavy logging and no optimizations, For this reason, **you should only use it for debugging purposes** and **when obtaining logs for creating an Issue**.
|
||||
|
||||
As for branches, you should always use the `main` branch, unless told otherwise by the developers, or if you want to test upcoming features and are aware of the risks involved.
|
||||
|
||||
### 2. Flash the zip
|
||||
|
||||
After choosing the right build, you should flash it using your current root manager, like Magisk or KernelSU. You can do this by going to the `Modules` section of your root manager and selecting the zip you downloaded.
|
||||
|
||||
After flashing, check the installation logs to ensure there are no errors, and if everything is fine, you can reboot your device.
|
||||
|
||||
> [!WARNING]
|
||||
> Magisk users should disable built-in Zygisk, as it will conflict with ReZygisk. This can be done by going to the `Settings` section of Magisk and disabling the `Zygisk` option.
|
||||
|
||||
### 3. Verify the installation
|
||||
|
||||
After rebooting, you can verify if ReZygisk is working properly by checking the module description in the `Modules` section of your root manager. The description should indicate that the necessary daemons are running. For example, if your environment supports both 64-bit and 32-bit, it should look similar to this: `[monitor: 😋 tracing, zygote64: 😋 injected, daemon64: 😋 running (...) zygote32: 😋 injected, daemon32: 😋 running (...)] Standalone implementation of Zygisk.`
|
||||
|
||||
## Translation
|
||||
|
||||
As of now, we don't have integration with another platform for translations but you may contribute to the [add/new-webui](https://github.com/PerformanC/ReZygisk/tree/add/new-webui) branch. Please don't forget to include your GitHub profile in [TRANSLATOR.md](https://github.com/PerformanC/ReZygisk/blob/add/new-webui/TRANSLATOR.md) so that people can see your contribution.
|
||||
There are currently two different ways to contribute translations for ReZygisk:
|
||||
|
||||
- For translations of the README, you can create a new file in the `READMEs` folder, following the naming convention of `README_<language>.md`, where `<language>` is the language code (e.g., `README_pt-BR.md` for Brazilian Portuguese), and open a pull request to the `main` branch with your changes.
|
||||
- For translations of the ReZygisk WebUI, you should first contribute to our [Crowdin](https://crowdin.com/project/rezygisk). Once approved retrieve the `.json` file from there and open a pull request with your changes -- adding the `.json` file to the `webroot/lang` folder and your credits to the `TRANSLATOR.md` file, in alphabetic order.
|
||||
|
||||
## Support
|
||||
|
||||
For any question related to ReZygisk or other PerformanC projects, feel free to join any of the following channels below:
|
||||
|
||||
- Discord Channel: [PerformanC](https://discord.gg/uPveNfTuCJ)
|
||||
- ReZygisk Telegram Channel: [@rezygiskchat](https://t.me/rezygiskchat)
|
||||
- ReZygisk Telegram Channel: [@rezygisk](https://t.me/rezygisk)
|
||||
- PerformanC Telegram Channel: [@performancorg](https://t.me/performancorg)
|
||||
- PerformanC Signal Group: [@performanc](https://signal.group/#CjQKID3SS8N5y4lXj3VjjGxVJnzNsTIuaYZjj3i8UhipAS0gEhAedxPjT5WjbOs6FUuXptcT)
|
||||
|
||||
## Contribution
|
||||
|
||||
|
||||
Reference in New Issue
Block a user