Initial Wiki page

Stig-Ørjan Smelror 2024-03-10 10:55:12 +01:00
parent 98407146fa
commit e7fad5b22f

55
Home.md

@ -1 +1,54 @@
An empty Wiki page.
# zrep - Zsh Repository Tool
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.
## Features
- **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`.
- **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.
- **Configuration via `.zreprc`:** Customizable settings through a dedicated configuration file.
## Getting Started
### Installation
1. Clone the `zrep` repository to your local machine.
2. Run the script with `zsh /path/to/zrep` to initialize the installation process.
### Configuration
Upon first run, `zrep` will prompt you to specify the installation directory, defaulting to `$HOME/.zrep` if left unspecified. This path will be used to store scripts, functions, and configuration files.
### `.zreprc` Configuration
The `.zreprc` file located in your home directory (`$HOME/.zreprc`) contains all configurable settings for `zrep`. Initially, this file will include the installation directory path. You can edit this file to adjust `zrep` settings to your liking.
## Usage
### Basic Commands
- `zrep init`: Initializes `zrep`, setting up necessary directories and configuration files.
- `zrep install <package>`: Installs a specified package.
- `zrep remove <package>`: Removes a specified package.
- `zrep enable <package>`: Enables a package, adding it to your `fpath`.
- `zrep disable <package>`: Disables a package, removing it from your `fpath`.
- `zrep list`: Lists all installed packages along with their status (active/inactive).
### Advanced Features
- **Color Customization:** Customize console output colors by editing the `colors` associative array within the script.
- **Package Management:** Leverage `zrep` to manage external Zsh scripts and functions efficiently, keeping your shell environment clean and organized.
## Contributing
Contributions to `zrep` are welcome! Whether it's adding new features, improving existing ones, or fixing bugs, your help is appreciated. Please follow the standard GitHub pull request process to submit your contributions.
## License
`zrep` is licensed under the MIT License. See the LICENSE file for more details.
---
For more detailed information on each command and feature, please refer to the corresponding sections of this Wiki or the `zrep` script comments.