docs: Move installer specific doc into the installer itself
This commit is contained in:
46
readme.md
46
readme.md
@@ -11,6 +11,8 @@ The goal is simple: reduce the number of manual steps required after installing
|
||||
| `install_nvim.sh` | Installs Neovim 0.11.7 and clones my Neovim configuration repository. |
|
||||
| `install_yazi.sh` | Installs Yazi terminal file manager and its dependencies. |
|
||||
|
||||
All scripts support Arch Linux, Debian / Ubuntu, and Fedora.
|
||||
|
||||
More scripts will be added over time.
|
||||
|
||||
## Usage
|
||||
@@ -29,36 +31,15 @@ b yazi
|
||||
b nvim,yazi
|
||||
```
|
||||
|
||||
## What the Neovim Installer Does
|
||||
## Uninstallation
|
||||
|
||||
The Neovim bootstrap script:
|
||||
To completely remove the bootstrap helper tool and clear out the shell configurations (leaving any installed software configs intact), run:
|
||||
|
||||
1. Detects the Linux distribution.
|
||||
2. Installs required dependencies (`git`, `wget`, `tar`).
|
||||
3. Checks whether Neovim 0.11.7 is already installed.
|
||||
4. Prompts before installing or upgrading Neovim.
|
||||
5. Installs the official Neovim binary to `/opt/nvim`.
|
||||
6. Creates a symlink at `/usr/local/bin/nvim`.
|
||||
7. Clones my Neovim configuration into `~/.config/nvim`.
|
||||
```bash
|
||||
b bye
|
||||
```
|
||||
|
||||
## What the Yazi Installer Does
|
||||
|
||||
The Yazi bootstrap script:
|
||||
|
||||
1. Detects the Linux distribution.
|
||||
2. Prompts before installing or upgrading Yazi.
|
||||
3. Installs Yazi:
|
||||
* **Arch Linux**: Installs `yazi` via pacman.
|
||||
* **Debian / Ubuntu**: Downloads the latest `.deb` release package from GitHub and installs it.
|
||||
* **Fedora**: Enables the COPR repository (`lihaohong/yazi`) and installs `yazi` (initially skipping weak dependencies).
|
||||
4. Subsequently installs the dependencies (`ffmpeg`, `7zip` / `p7zip-full`, `jq`, `poppler`, `fd` / `fd-find`, `ripgrep`, `fzf`, `zoxide`, `resvg`, `imagemagick`) to make Yazi available quicker.
|
||||
5. Configures a shell wrapper function `y` in `~/.bashrc` and `~/.zshrc` that allows changing directory on exit.
|
||||
|
||||
Supported distributions:
|
||||
|
||||
* Arch Linux
|
||||
* Debian / Ubuntu
|
||||
* Fedora
|
||||
Then reload your shell configuration or run `unset -f b` to clear the function definition from your current terminal session.
|
||||
|
||||
## Philosophy
|
||||
|
||||
@@ -73,17 +54,6 @@ That means they may make assumptions about:
|
||||
|
||||
The scripts are intentionally straightforward Bash scripts that can be inspected and modified before execution.
|
||||
|
||||
## Repository Structure
|
||||
|
||||
```text
|
||||
.
|
||||
├── bootstrap.sh
|
||||
├── routes.sh
|
||||
└── installers/
|
||||
├── install_nvim.sh
|
||||
└── install_yazi.sh
|
||||
```
|
||||
|
||||
## Future Plans
|
||||
|
||||
Potential additions include:
|
||||
|
||||
Reference in New Issue
Block a user