diff options
| author |   memdmp <memdmpestrogenzone> | 2025-05-27 21:16:00 +0200 |
|---|---|---|
| committer | memdmp <memdmpestrogenzone> | 2025-05-27 21:16:00 +0200 |
| commit | 37170eae7d1ab80d7259b6824ca930f6a03a1aee (patch) | |
| tree | f3c835bfe73841157525aff5a0a9ae3f6798ee0b /README.md | |
| parent | f472ea579eda9bdb968fd131316f684c6258f57a (diff) | |
| download | zuwu-37170eae7d1ab80d7259b6824ca930f6a03a1aee.tar.gz zuwu-37170eae7d1ab80d7259b6824ca930f6a03a1aee.tar.bz2 zuwu-37170eae7d1ab80d7259b6824ca930f6a03a1aee.tar.lz zuwu-37170eae7d1ab80d7259b6824ca930f6a03a1aee.zip | |
feat: packages
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 23 |
1 files changed, 15 insertions, 8 deletions
@@ -12,21 +12,28 @@ zuwu.zsh (zuwu) is a highly opinionated zsh "plugin" that provides sensible defa ## installation -### from repo +### from package -Run `git clone https://git.estrogen.zone/zuwu.git /tmp/zuwu --depth 1 && cd /tmp/zuwu && ./install.zsh && cd - && rm -rf /tmp/zuwu` +#### alpine -then follow the outputted instructions. +The [alpine-packages.git](https://git.estrogen.zone/alpine-packages.git/) repository on [git.estrogen.zone](https://git.estrogen.zone) contains [a package for zuwu](https://git.estrogen.zone/alpine-packages.git/tree/src/memdmp/zsh-zuwu). In the near future, this package will be provided on a 3rd-party repository of some kind. -> Replace `./install.zsh` with `doas ./install.zsh` or `sudo ./install.zsh` to get a system-wide install +You can build the package yourself; in the cloned repository, assuming [alpine-sdk is installed](https://pkgs.alpinelinux.org/package/edge/main/x86_64/alpine-sdk) and [abuild keys have been setup](https://wiki.alpinelinux.org/wiki/Abuild_and_Helpers#Setting_up_the_build_environment), you can run `FILTER=zsh-zuwu ./build-repo` to build the package, and `doas ./pkg add zsh-zuwu` to install it. The package will, on installation, provide the path needed for the script that configures your `.zshrc`. -### from package +Alternatively, you can install the CI's [Signing Key](https://builds.neobot.systems/alpine/keys/builder@neobot.systems-6834be51.rsa.pub) to `/etc/apk/keys/builder@neobot.systems-6834be51.rsa.pub` and add `https://builds.neobot.systems/alpine/repos/memdmp/` to your `/etc/apk/repos`. Note that this only builds tagged releases from the above repositories.<br/> +Once added, run `apk add zsh-zuwu zsh-fast-syntax-highlighting zsh-autosuggestions` (or just `zsh-zuwu` if you don't want those plugins to be used). -#### alpine +#### arch -The [alpine-packages.git](https://git.estrogen.zone/alpine-packages.git/) repository on [git.estrogen.zone](https://git.estrogen.zone) contains [a package for zuwu](https://git.estrogen.zone/alpine-packages.git/tree/src/memdmp/zsh-zuwu). In the near future, this package will be provided on a 3rd-party repository of some kind. +There are occasional package builds (from [./packaging/arch](./packaging/arch)) available on [Codeberg Packages](https://codeberg.org/dmpmem/-/packages/arch/zsh-zuwu). If you depend on up-to-date zuwu, it is recommended to follow the below instead. + +### from repo + +Run `git clone https://git.estrogen.zone/zuwu.git /tmp/zuwu --depth 1 && cd /tmp/zuwu && ./install.zsh && cd - && rm -rf /tmp/zuwu` + +then follow the outputted instructions. -For now, you can build the package yourself; in the cloned repository, assuming [alpine-sdk is installed](https://pkgs.alpinelinux.org/package/edge/main/x86_64/alpine-sdk) and [abuild keys have been setup](https://wiki.alpinelinux.org/wiki/Abuild_and_Helpers#Setting_up_the_build_environment), you can run `FILTER=zsh-zuwu ./build-repo` to build the package, and `doas ./pkg add zsh-zuwu` to install it. The package will, on installation, provide the path needed for the script that configures your `.zshrc`. +> Replace `./install.zsh` with `doas ./install.zsh` or `sudo ./install.zsh` to get a system-wide install ### when living life dangerously |