aboutsummarylogtreecommitdiffstats
path: root/README.md
blob: 3e12ed82793e4c8919568a3f8fff9ce3e7dd4c2c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
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`