This commit is contained in:
abbie 2023-08-10 12:22:56 +01:00
parent 34a9ff558c
commit 04efd9a96d
Signed by: threeoh6000
GPG key ID: 801FE4AD456E922C
4 changed files with 43 additions and 3 deletions

View file

@ -1,3 +1,3 @@
#!/bin/sh #!/bin/sh
cp test.sh ../../bin/test-package cp test.sh ../../bin/hello-curze
chmod +x ../../bin/test-package chmod +x ../../bin/hello-curze

View file

@ -1,2 +1,2 @@
#!/bin/sh #!/bin/sh
rm ../../bin/test-package rm ../../bin/hello-curze

13
LICENSE Normal file
View file

@ -0,0 +1,13 @@
DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
Version 2, December 2004
Copyright (C) 2004 Sam Hocevar <sam@hocevar.net>
Everyone is permitted to copy and distribute verbatim or modified
copies of this license document, and changing it is allowed as long
as the name is changed.
DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
0. You just DO WHAT THE FUCK YOU WANT TO.

View file

@ -0,0 +1,27 @@
# 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!
```sh
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.