Minor corrections
parent
e7fad5b22f
commit
821171dee1
14
Home.md
14
Home.md
@ -2,11 +2,12 @@
|
|||||||
|
|
||||||
Welcome to the official Wiki for `zrep`, a comprehensive Zsh Repository Tool designed to enhance your Zsh experience. Developed with flexibility and ease of use in mind, `zrep` allows for the efficient management of Zsh functions, scripts, and addons.
|
Welcome to the official Wiki for `zrep`, a comprehensive Zsh Repository Tool designed to enhance your Zsh experience. Developed with flexibility and ease of use in mind, `zrep` allows for the efficient management of Zsh functions, scripts, and addons.
|
||||||
|
|
||||||
|
`zrep` is meant to be used on a per user basis and not globally. This means that you, the user, have full control over what is installed and activated.
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
- **Version Control:** Easily track the version of your `zrep` installation with a straightforward versioning system.
|
- **Version Control:** Easily track the version of your `zrep` installation with a straightforward versioning system.
|
||||||
- **Dynamic Function Path Management:** Automatically adds directories containing at least one file to `fpath`.
|
- **Dynamic Function Path Management:** Automatically adds directories containing at least one file to `fpath`.
|
||||||
- **Color Support:** Enhances the readability of console output with a broad color palette.
|
|
||||||
- **Modular Design:** Supports the installation, removal, and management of Zsh addons and scripts.
|
- **Modular Design:** Supports the installation, removal, and management of Zsh addons and scripts.
|
||||||
- **Configuration via `.zreprc`:** Customizable settings through a dedicated configuration file.
|
- **Configuration via `.zreprc`:** Customizable settings through a dedicated configuration file.
|
||||||
|
|
||||||
@ -15,7 +16,7 @@ Welcome to the official Wiki for `zrep`, a comprehensive Zsh Repository Tool des
|
|||||||
### Installation
|
### Installation
|
||||||
|
|
||||||
1. Clone the `zrep` repository to your local machine.
|
1. Clone the `zrep` repository to your local machine.
|
||||||
2. Run the script with `zsh /path/to/zrep` to initialize the installation process.
|
2. Run the script with `zrep init` to initialize the installation process.
|
||||||
|
|
||||||
### Configuration
|
### Configuration
|
||||||
|
|
||||||
@ -30,11 +31,12 @@ The `.zreprc` file located in your home directory (`$HOME/.zreprc`) contains all
|
|||||||
### Basic Commands
|
### Basic Commands
|
||||||
|
|
||||||
- `zrep init`: Initializes `zrep`, setting up necessary directories and configuration files.
|
- `zrep init`: Initializes `zrep`, setting up necessary directories and configuration files.
|
||||||
- `zrep install <package>`: Installs a specified package.
|
- `zrep install <author/package>`: Installs a specified package.
|
||||||
- `zrep remove <package>`: Removes a specified package.
|
- `zrep remove <author/package>`: Removes a specified package.
|
||||||
- `zrep enable <package>`: Enables a package, adding it to your `fpath`.
|
- `zrep enable <author/package>`: Enables a package, adding it to your `fpath`.
|
||||||
- `zrep disable <package>`: Disables a package, removing it from your `fpath`.
|
- `zrep disable <author/package>`: Disables a package, removing it from your `fpath`.
|
||||||
- `zrep list`: Lists all installed packages along with their status (active/inactive).
|
- `zrep list`: Lists all installed packages along with their status (active/inactive).
|
||||||
|
- `zrep <author/package> help`: Show the included usage information for package.
|
||||||
|
|
||||||
### Advanced Features
|
### Advanced Features
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user