From e7fad5b22f483cba18d07a240a17b14d57439b61 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Stig-=C3=98rjan=20Smelror?= Date: Sun, 10 Mar 2024 10:55:12 +0100 Subject: [PATCH] Initial Wiki page --- Home.md | 55 ++++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 54 insertions(+), 1 deletion(-) diff --git a/Home.md b/Home.md index d8dcfa7..0fe8644 100644 --- a/Home.md +++ b/Home.md @@ -1 +1,54 @@ -An empty Wiki page. \ No newline at end of file +# 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 `: Installs a specified package. +- `zrep remove `: Removes a specified package. +- `zrep enable `: Enables a package, adding it to your `fpath`. +- `zrep disable `: 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. \ No newline at end of file