Magisk/README.MD

42 lines
2.8 KiB
Plaintext
Raw Normal View History

2016-09-14 04:31:13 +02:00
# Magisk
2018-09-09 18:25:22 +02:00
[XDA Announcement Thread](https://forum.xda-developers.com/apps/magisk/official-magisk-v7-universal-systemless-t3473445)
2016-11-08 22:16:03 +01:00
2018-05-12 21:04:40 +02:00
## Building Environment Requirements
2018-01-27 01:25:34 +01:00
1. Python 3.5+: run `build.py` script
2. Java Development Kit (JDK) 8: Compile Magisk Manager and sign zips
2018-05-12 21:04:40 +02:00
3. Latest Android SDK: set `ANDROID_HOME` environment variable to the path to Android SDK
4. Android NDK: Install NDK along with SDK (`$ANDROID_HOME/ndk-bundle`), or optionally specify a custom path `ANDROID_NDK_HOME`
2018-01-27 01:25:34 +01:00
5. (Windows Only) Python package Colorama: Install with `pip install colorama`, used for ANSI color codes
2017-06-03 20:49:24 +02:00
2018-05-12 21:04:40 +02:00
## Building Notes and Instructions
2018-09-09 18:25:22 +02:00
1. Clone sources with submodules: `git clone --recurse-submodules https://github.com/topjohnwu/Magisk.git`
2. Building is supported on macOS, Linux, and Windows. Official releases are built and tested with [FrankeNDK](https://github.com/topjohnwu/FrankeNDK); point `ANDROID_NDK_HOME` to FrankeNDK if you want to use it for compiling.
3. Set configurations in `config.prop`. A sample file `config.prop.sample` is provided as an example.
4. Run `build.py` with argument `-h` to see the built-in help message. The `-h` option also works for each supported actions, e.g. `./build.py binary -h`
5. By default, `build.py` build binaries and Magisk Manager in debug mode. If you want to build Magisk Manager in release mode (via the `-r, --release` flag), you need a Java Keystore file `release-key.jks` (only `JKS` format is supported) to sign APKs and zips. For more information, check out [Google's Official Documentation](https://developer.android.com/studio/publish/app-signing.html#signing-manually).
## Bug Reports
**Make sure to install the latest [Canary Build](https://forum.xda-developers.com/apps/magisk/dev-magisk-canary-channel-bleeding-edge-t3839337) before reporting any bugs!** Please **DO NOT** report bugs that is already fixed upstream.
Follow the instructions in the [Canary Channel XDA Thread](https://forum.xda-developers.com/apps/magisk/dev-magisk-canary-channel-bleeding-edge-t3839337), and report a bug either by opening an issue on GitHub or directly in the thread.
2017-06-03 20:49:24 +02:00
2018-07-28 09:10:06 +02:00
## Documentation
[Link to Documentation](docs/README.MD)
2017-06-03 20:49:24 +02:00
## License
2017-08-20 09:03:26 +02:00
```
2017-10-31 10:05:24 +01:00
Magisk, including all git submodules are free software:
2017-08-20 09:03:26 +02:00
you can redistribute it and/or modify it under the terms of the
GNU General Public License as published by the Free Software Foundation,
either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
2017-08-20 09:03:26 +02:00
```