Skip to content

Commit 4fdf8ca

Browse files
author
SAP Team
authored
Create README.md
1 parent c964800 commit 4fdf8ca

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# SAPTeam's Magisk module template
2+
This magis module template made the module creation way easier.
3+
4+
## Features
5+
- Automates the build and releasing with Github actions.
6+
- Easily initiates the module properties with setup.py.
7+
- Has a biult in installer script, so you don't need to write a installer script.
8+
9+
## Getting started
10+
Working with this template is very easy. Most of actions is automated. with this instruction you can benefit all features of this module:
11+
- First you need to make a fork of this repository to your account.
12+
- Then clone your new repository to your computer.
13+
- in module files open `setup.py` with an text editor and replace the variables with your module props.
14+
- Run `setup.py` and after after finishing the first run, delete it.
15+
- Open `module.prop` and `update.json` and change the version and github repo link strings. You don't need to change the entire link, just correct the github account and repo name.
16+
- Put your module files and update the changelog.
17+
- Create a tag and push it. when a new tag is pushed the action is triggered and new release zip is automatically created.
18+
You must check the Actions tab of your project for checking issues.
19+
20+
Note: for using magisk 14.0+ update api you need to update the version string in `update.json` in every releases.
21+
22+
## Credits
23+
This module forked from [MMT-Extended](https://github.com/Zackptg5/MMT-Extended) template.

0 commit comments

Comments
 (0)