more entries in the catalog ; more readme and faq ; onging impl

This commit is contained in:
2023-02-08 15:27:58 +01:00
parent 36be71ca89
commit ef3719aee5
6 changed files with 152 additions and 1 deletions

View File

@@ -35,6 +35,8 @@ Inspired by envinstall (private), [webinstall](gh:webinstall/webi-installers), [
- [ ] identify installed version
- [ ] can install itself
- [ ] have nice defaults (gh release, targz, x86_64, linux, etc.)
- [ ] favor convention over configuration
- [ ] tries to guess as much as possible
- [ ] small codebase, preferably one file
@@ -48,6 +50,20 @@ Inspired by envinstall (private), [webinstall](gh:webinstall/webi-installers), [
- overlap with package managers (apt, yum, etc.) or environment managers (nix, asdf, etc.)
# conventions and defaults
* default status of an entry is "tested" which means the process has been tested under linux-amd64
* entry name in the catalog is the name of the exe ; a prefered name can be added as a property
* tools in unpacked in `~/.local/programs` then symlinked in `~/.local/bin` which must be in PATH
* semver = semantic versioning : tools are versionned as `major[.minor[.patch[-prerelease[+build]]]]` so versions can be compared
* installed version is obtained by ruinning `<cli> --version`
* OS and arch are obtained with `os.uname()` python function
* default release system is GitHub releases and use `repo` property
* default packaging is `.tar.gz`
* default structure is to have the exe in the `bin` folder
most defaults can be overriden
# FAQ
@@ -70,6 +86,10 @@ Tools developers / maintainers are not supposed to know CliGet exists. It adapts
Only the first time. After being installed, CliGet is managed by CliGet.
#### why this name ?
It is like wget but fo CLI. Plus, I like the sound of it :)
#### I already use [asdf](https://asdf-vm.com/), why would I need cliget ?
asdf is a wonderful tool when it comes to do software development in various programming language while mixing versions from one project to an other.