Skip to content

Latest commit

 

History

History
54 lines (33 loc) · 2 KB

README_EN.md

File metadata and controls

54 lines (33 loc) · 2 KB

简体中文 | English

GitHub Commit GitHub License

🚀 Quick Start

Welcome to use this module framework! Here are the steps to get started:

📥 Get the Framework

  • Fork this repository or download this repository directly.

⚙️ Configuration Settings

  1. Edit the ./settings/Settings.sh file:

    • Write your module name and module description.
    • Specify the environment required by the module.

  2. Edit the ./settings/languages.ini file to enable multi-language support.

🛠️ Custom Scripts

  • Do not use custmize.sh as the custom installation script.
  • You should choose ./settings/custom_script.sh as the custom script.
  • This framework provides some functions, please read the instructions.

🌐 Custom WebUI

  • WebUI allows users to easily configure the values of variables in settings.sh.
  • See WebUI User Guide for more information.

🖱️ User Scripts

  • Click.sh can be used by users to execute scripts provided by the module outside the module.
  • Click.sh uses busybox to execute ./settings/script/custom_script_user.sh in /data/local/tmp/.
  • This framework provides some functions, please read the instructions.

🏗️ Framework Applicability

  • This framework is suitable for GitHub Action to package modules.
  • This framework removes META-INF by default, please add it yourself if needed.

📝 Update Notes

  • For future updates to the module framework, please check the Update Notes.

PRs are welcome. If you find it useful, please give it a star. Thank you for using this framework! 🚀

(Extracted and modified from AuroraNasa_Installer, please don't criticize if you don't like it)