Hello, curze!

curze is a source-based package manager for git.colean.cc, all repositories on git.colean.cc can be turned into curze compatible packages with little work on the part of the developer.

How do I install curze?

Just by following the commands below!

mkdir ~/.local/share/curze
mkdir ~/.local/share/curze/bin
mkdir ~/.local/share/curze/cache
cd ~/.local/share/curze/cache
git clone https://git.colean.cc/meta/curze meta.curze
cd meta.curze
./.curze/build.sh
./.curze/install.sh
cp .curze/version ../../meta.curze.version

Remember to add $HOME/.local/share/curze/bin to your path!

How do I make my repository curze installable?

First, you must announce compatibility with curze by adding the install-with-curze topic to your git repository. You can do this by going onto your git repository's page and clicking the "Manage topics" text above the commits/branch/tags/space usage bar. This is required otherwise curze will not be able to recognise that your repository is installable with curze.

Next, you must add a .curze directory to your repository and adding a version file inside. This is an unsigned 32-bit integer ranging from 0 to 4.2 billion. I recommend you either start at version 0 or 1. The required shell scripts for a curze package are install.sh and uninstall.sh which are automatically run by the install and uninstall subcommands respectively. When your package is being installed or built, your repository is downloaded to the location ~/.local/share/curze/cache/username.repo-name and this is the path of the working directory when your scripts are executed. Packages should install to ~/.local/share/curze/bin or ../../bin. Example install and uninstall scripts are provided in this repository's .curze folder.

What if I need my package to be built before being installed.

Build steps can be provided with build.sh, this file is automatically ran before installation by curze install as well as being ran by curze build. This file isn't required to allow shell scripts and other programs that don't require build steps before installation to be able to be installed by curze as well.