-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(README): supplementary reliance requirements #11
- Loading branch information
1 parent
3e14d79
commit 2ce59c4
Showing
2 changed files
with
32 additions
and
30 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,30 +1,31 @@ | ||
# Batch keybox checker | ||
|
||
## Requirements | ||
Python >= 3.8 | ||
For restricted network environments, it may be necessary to set the web proxy environment variables: `HTTP_PROXY`, `HTTPS_PROXY`, `ALL_PROXY`. (See: [Requests documentation](https://requests.readthedocs.io/en/latest/user/advanced/#proxies) for details) | ||
|
||
## Install | ||
```bash | ||
pip install keyboxchecker | ||
``` | ||
|
||
## Usage | ||
```bash | ||
usage: keyboxchecker [-h] [-a] [-o OUTPUT] [-p PATH] | ||
|
||
options: | ||
-h, --help show this help message and exit | ||
-a, --aosp Categorizes the AOSP keybox as "Survivor" with a default value of "False" | ||
-o OUTPUT, --output OUTPUT | ||
Resulting output directory, defaults to current Directory | ||
-p PATH, --path PATH Directory where keybox is located, defaults to current directory | ||
``` | ||
|
||
## Uninstall | ||
```bash | ||
pip uninstall keyboxchecker | ||
``` | ||
|
||
## Credits | ||
[KimmyXYC/KeyboxChecker](https://github.com/KimmyXYC/KeyboxChecker) | ||
# Batch keybox checker | ||
|
||
## Requirements | ||
Rust (Compile-Time) | ||
Python >= 3.8 | ||
For restricted network environments, it may be necessary to set the web proxy environment variables: `HTTP_PROXY`, `HTTPS_PROXY`, `ALL_PROXY`. (See: [Requests documentation](https://requests.readthedocs.io/en/latest/user/advanced/#proxies) for details) | ||
|
||
## Install | ||
```bash | ||
pip install keyboxchecker | ||
``` | ||
|
||
## Usage | ||
```bash | ||
usage: keyboxchecker [-h] [-a] [-o OUTPUT] [-p PATH] | ||
|
||
options: | ||
-h, --help show this help message and exit | ||
-a, --aosp Categorizes the AOSP keybox as "Survivor" with a default value of "False" | ||
-o OUTPUT, --output OUTPUT | ||
Resulting output directory, defaults to current Directory | ||
-p PATH, --path PATH Directory where keybox is located, defaults to current directory | ||
``` | ||
|
||
## Uninstall | ||
```bash | ||
pip uninstall keyboxchecker | ||
``` | ||
|
||
## Credits | ||
[KimmyXYC/KeyboxChecker](https://github.com/KimmyXYC/KeyboxChecker) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters