mirror of
https://github.com/ChrisTitusTech/linutil.git
synced 2024-12-25 12:59:45 +00:00
Move the installation procedure before USAGE
This commit is contained in:
parent
15c40d1297
commit
4834c7ac30
64
README.md
64
README.md
|
@ -14,38 +14,6 @@
|
||||||
> [!NOTE]
|
> [!NOTE]
|
||||||
> Since the project is still in active development, you may encounter some issues. Please consider [submitting feedback](https://github.com/ChrisTitusTech/linutil/issues) if you do.
|
> Since the project is still in active development, you may encounter some issues. Please consider [submitting feedback](https://github.com/ChrisTitusTech/linutil/issues) if you do.
|
||||||
|
|
||||||
## 💡 Usage
|
|
||||||
To get started, pick which branch you would like to use, then run the command in your terminal:
|
|
||||||
### Stable Branch (Recommended)
|
|
||||||
```bash
|
|
||||||
curl -fsSL https://christitus.com/linux | sh
|
|
||||||
```
|
|
||||||
### Dev branch
|
|
||||||
```bash
|
|
||||||
curl -fsSL https://christitus.com/linuxdev | sh
|
|
||||||
```
|
|
||||||
|
|
||||||
### CLI arguments
|
|
||||||
|
|
||||||
Linutil supports various command-line arguments to customize its behavior. Here are some common arguments you can use:
|
|
||||||
|
|
||||||
- `-c, --config <CONFIG>` : Path to the configuration file.
|
|
||||||
- `--override-validation` : Show all available options, disregarding compatibility checks (UNSAFE).
|
|
||||||
- `--size-bypass` : Bypass the terminal size limit.
|
|
||||||
- `-y, --skip-confirmation` : Skip confirmation prompt before executing commands.
|
|
||||||
- `-t, --theme <THEME>` : Set the theme to use in the application [default: `default`] [possible values: `default`, `compatible`].
|
|
||||||
- `-h, --help` : Print help.
|
|
||||||
|
|
||||||
For more detailed usage, run:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
curl -fsSL https://christitus.com/linux | sh -s -- --help
|
|
||||||
```
|
|
||||||
|
|
||||||
```bash
|
|
||||||
linutil --help
|
|
||||||
```
|
|
||||||
|
|
||||||
## ⬇️ Installation
|
## ⬇️ Installation
|
||||||
|
|
||||||
Linutil is also available as a package in various repositories:
|
Linutil is also available as a package in various repositories:
|
||||||
|
@ -102,6 +70,38 @@ Note that crates installed using `cargo install` require manual updating with `c
|
||||||
|
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
|
## 💡 Usage
|
||||||
|
To get started, pick which branch you would like to use, then run the command in your terminal:
|
||||||
|
### Stable Branch (Recommended)
|
||||||
|
```bash
|
||||||
|
curl -fsSL https://christitus.com/linux | sh
|
||||||
|
```
|
||||||
|
### Dev branch
|
||||||
|
```bash
|
||||||
|
curl -fsSL https://christitus.com/linuxdev | sh
|
||||||
|
```
|
||||||
|
|
||||||
|
### CLI arguments
|
||||||
|
|
||||||
|
Linutil supports various command-line arguments to customize its behavior. Here are some common arguments you can use:
|
||||||
|
|
||||||
|
- `-c, --config <CONFIG>` : Path to the configuration file.
|
||||||
|
- `--override-validation` : Show all available options, disregarding compatibility checks (UNSAFE).
|
||||||
|
- `--size-bypass` : Bypass the terminal size limit.
|
||||||
|
- `-y, --skip-confirmation` : Skip confirmation prompt before executing commands.
|
||||||
|
- `-t, --theme <THEME>` : Set the theme to use in the application [default: `default`] [possible values: `default`, `compatible`].
|
||||||
|
- `-h, --help` : Print help.
|
||||||
|
|
||||||
|
For more detailed usage, run:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
curl -fsSL https://christitus.com/linux | sh -s -- --help
|
||||||
|
```
|
||||||
|
|
||||||
|
```bash
|
||||||
|
linutil --help
|
||||||
|
```
|
||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
|
|
||||||
Linutil supports configuration through a TOML config file. Path to the file can be specified with `--config` (or `-c`).
|
Linutil supports configuration through a TOML config file. Path to the file can be specified with `--config` (or `-c`).
|
||||||
|
|
Loading…
Reference in New Issue
Block a user