diff options
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 74 |
1 files changed, 74 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 000000000000..3e12ed82793e --- /dev/null +++ b/README.md @@ -0,0 +1,74 @@ + +# The NitroN: Open Edition + +## Table of Contents + +- [Overview](#overview) +- [Requirements](#requirements) +- [Installation](#installation) +- [Options](#options) +- [Reporting Issues](#reporting-issues) +- [License](#license) + +## Overview +OpenNitroN (`nitrond`) is a two-way modular Universal kernel +optimizer written in bash which is extensive. + +What it means to be Universal two-way is that it is +an argument-based script and a menu-based script for Android and/or Linux platforms. + +## Requirements +- A compatible Linux system +- SuperUser permissions + +## Options +``` +Usage: nitrond [OPTION] (e.g. nitrond --update) + +Commands: + deviceinfo ~ shows device resource information + clean ~ wipe stored nitron data + auto ~ automatically decide mode switchment up on Environment status + +Options: + -sdm, --show-default-mode ~ prints current tweaking mode + -sg, --set-green ~ apply Battery mode + -sr, --set-red ~ apply Gaming mode + -sy, --set-yellow ~ apply Balanced mode + -c, --console-mode ~ enter User-Friendly user selections + +Others: + -h, --help ~ shows this Help menu + -v, --version ~ shows tool version + -u, --update ~ update to latest + +Advanced: + -dd, --downgrade ~ downgrade to previous upgrade + -d, --debug ~ run commands under debuggable verbose flags +``` + +## Reporting Issues + +Found a problem? Want a new feature? Have a question? +First of all see if your issue, question or idea has [already been reported](https://github.com/UsiFX/OpenNitroN/issues?q=is%3Aissue). +If don't, just open a [new clear and descriptive issue](https://github.com/UsiFX/OpenNitroN/issues/new/choose). + +## License + +``` +nitronD v1.1.0 (An Extensive Kernel tweaker) +Copyright (c) 2022-2023 UsiFX <xprjkts@gmail.com> + + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + +Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/> +Everyone is permitted to copy and distribute verbatim copies +of this license document, but changing it is not allowed. +``` + +### Buy me a Coffee? + +PAYPAL: `xprjkts@gmail.com` + +KO-FI: `https://ko-fi.com/xprjkt` |