From 5e9648387a00b5dbe1151185e7bf2d63bffc5949 Mon Sep 17 00:00:00 2001 From: topjohnwu Date: Mon, 14 Aug 2017 03:46:23 +0800 Subject: [PATCH] Merge module and repo docs --- docs/README.MD | 7 ++++--- docs/{module.md => module_repo.md} | 18 ++++++++++++++++++ docs/repo.md | 16 ---------------- 3 files changed, 22 insertions(+), 19 deletions(-) rename docs/{module.md => module_repo.md} (69%) delete mode 100644 docs/repo.md diff --git a/docs/README.MD b/docs/README.MD index e573a9f4a..7c18438c6 100644 --- a/docs/README.MD +++ b/docs/README.MD @@ -1,7 +1,8 @@ # Magisk Documentations +#### (Updated on 2017.8.14 for Magisk v13.5+) - Magisk Details - **(Important!)** [Full Procedures](https://cdn.rawgit.com/topjohnwu/Magisk/3a084c5d7b121bc9a94ea0372d9c808c2518f7cc/docs/procedures.html) -- Modules and Repos - - [Modules and Templates](module.md) - - [Submit Modules to Repo](repo.md) +- [Modules and Repos](module_repo.md) + - [Modules and Templates](module_repo.md#magisk-module-format) + - [Submit Modules to Repo](module_repo.md#submit-your-module-to-magisk-modules-repo) \ No newline at end of file diff --git a/docs/module.md b/docs/module_repo.md similarity index 69% rename from docs/module.md rename to docs/module_repo.md index e16e6bdc0..ab4294b40 100644 --- a/docs/module.md +++ b/docs/module_repo.md @@ -1,3 +1,4 @@ +# Magisk Modules and Online Repo ## Magisk Module Format The Magisk module is a folder under `magisk`, which has a structure as described below: @@ -48,8 +49,25 @@ Here are some files you would want to know: 1. Directly zip your files, and the result zip file is a flashable zip for both Magisk Manager and custom recoveries 1. Please check **Notes** for precautions +## Submit Your Module to Magisk Modules Repo +If you want to share your module with others, you can submit your modules to [Magisk Modules Repo](https://github.com/Magisk-Modules-Repo). In order to submit a module, you will need to know how to use some basic `git`. + +1. Create a module as stated [here](module.md), and test if it works properly +1. Fork [this repo](https://github.com/topjohnwu/magisk-module-template) to your account +1. Commit and push your changes to your forked repo +1. Open an issue in [topjohnwu/Magisk_Repo_Central](https://github.com/topjohnwu/Magisk_Repo_Central/issues/new) with your repo link +1. I will review your module, and once accepted, your repo should be cloned into [Magisk-Modules-Repo](https://github.com/Magisk-Modules-Repo), and you should receive an email to become the collaborator so you can edit the repo in the future. + +#### Once your module is live on the Modules Repo, the description of your repo should be the ID of your module. Please do NOT change the description, repeat, do NOT change the description. + ## Notes - The Module Template depends on external scripts installed by Magisk, so it each version of template will has its own minimal Magisk version requirement. - **Windows users please aware!!** The line endings on all text files should be the **Unix format**. Please use advanced text editors like Sublime, Atom, Notepad++ etc., **NEVER** use Windows Notepad. - In `module.prop`, `version` can be an arbitrary string, so any fancy version name (e.g. ultra-beta-v1.1.1.1) is allowed. However, `versionCode` **MUST** be an integer. The value is used for version comparison. - Make sure your module ID **doesn't contain any spaces**. + +## For Repo Developers + +- Magisk Manager monitors all repo's `master` branch. Any changes to the branch `master` will be reflected to all users immediately. If you are working on an update for a module, please work on another branch, make sure it works, then finally merge the changes back to `master`. +- Once you finished upgrading your repo, bump up at least the `versionCode` in `module.prop`, so Magisk Manager will know you module is updated! +- The description of your repo should be the same as your module ID. If you changed your description, Magisk Manager will fail to identify your repo, and cannot relate installed module to the online repo together. \ No newline at end of file diff --git a/docs/repo.md b/docs/repo.md deleted file mode 100644 index 45ae419f5..000000000 --- a/docs/repo.md +++ /dev/null @@ -1,16 +0,0 @@ -## Submit Your Module to Magisk Modules Repo -If you want to share your module with others, you can submit your modules to [Magisk Modules Repo](https://github.com/Magisk-Modules-Repo). In order to submit a module, you will need to know how to use some basic `git`. - -1. Create a module as stated [here](module.md), and test if it works properly -1. Fork [this repo](https://github.com/topjohnwu/magisk-module-template) to your account -1. Commit and push your changes to your forked repo -1. Open an issue in [topjohnwu/Magisk_Repo_Central](https://github.com/topjohnwu/Magisk_Repo_Central/issues/new) with your repo link -1. I will review your module, and once accepted, your repo should be cloned into [Magisk-Modules-Repo](https://github.com/Magisk-Modules-Repo), and you should receive an email to become the collaborator so you can edit the repo in the future. - -#### Once your module is live on the Modules Repo, the description of your repo should be the ID of your module. Please do NOT change the description, repeat, do NOT change the description. - -## Notes - -- Magisk Manager monitors all repo's `master` branch. Any changes to the branch `master` will be reflected to all users immediately. If you are working on an update for a module, please work on another branch, make sure it works, then finally merge the changes back to `master`. -- Once you finished upgrading your repo, bump up at least the `versionCode` in `module.prop`, so Magisk Manager will know you module is updated! -- The description of your repo should be the same as your module ID. If you changed your description, Magisk Manager will fail to identify your repo, and cannot relate installed module to the online repo together. \ No newline at end of file