Skip to content

Commit 6d6ec2b

Browse files
authored
docs(soar): Document the current state of it, after its rewrite
1 parent 6ad94a2 commit 6d6ec2b

3 files changed

Lines changed: 9 additions & 11 deletions

File tree

modules/soar/README.md

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,8 @@
22

33
The `soar` module installs & integrates the [`soar`](https://github.com/pkgforge/soar) package manager as an alternative to [Homebrew / Linuxbrew](https://brew.sh/).
44

5-
[`soar`](https://github.com/pkgforge/soar) is a package manager, which manages the installation of portable & static binaries.
6-
[PkgForge's](https://github.com/pkgforge) `bincache` repo is used by default for the binaries.
7-
Other repos that contain GUI applications are disabled to make `soar` focused on CLI binaries only.
8-
This is configurable if you wish to have a package manager for GUI applications, see [`Configuration options`](#configuration-options).
9-
10-
The repositories with prebuilt binaries use the GitHub Container registry as their backend and all their packages are published there.
5+
[`soar`](https://github.com/pkgforge/soar) is a package manager, which manages the installation of portable & static binaries & applications.
6+
[PkgForge's](https://github.com/pkgforge) `soarpkgs` repo is used by default for the packages.
117

128
Compared to [Homebrew / Linuxbrew](https://brew.sh/):
139
- there are no managed dependencies for packages by design (single package = single binary).
@@ -24,9 +20,11 @@ For more information, please see the [official documentation of `soar`](https://
2420

2521
## Repos
2622

27-
To see the useful information about source, reliability, trust & security of all `soar` repos, including external ones, you can open the links below:
28-
- https://docs.pkgforge.dev/repositories
29-
- https://docs.pkgforge.dev/repositories/external
23+
Currently, only the default `soarpkgs` repo exists.
24+
Third-party repos are possible to be made and used, but not by default in this module.
25+
26+
Historically, when this module was initially introduced, a good number of `pkgforge` repos existed.
27+
However, the previous maintainer of `pkgforge` repos Azathothas (also known as Ajam) quit and its maintainership was handled to the `soar` developer QaidVoid, who decided to remove all these repos and focus on the default repo `soarpkgs`.
3028

3129
## Local modification
3230

modules/soar/soar-upgrade-packages.service

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,5 @@ After=network-online.target
55

66
[Service]
77
Type=oneshot
8-
ExecCondition=/bin/bash -c 'if ps aux | grep -v grep | grep -E -q " /sbin/soar | /bin/soar | /usr/sbin/soar | /usr/bin/soar | soar "; then exit 1; else exit 0; fi'
8+
ExecCondition=/bin/sh -c 'if ps aux | grep -v grep | grep -E -q " /sbin/soar | /bin/soar | /usr/sbin/soar | /usr/bin/soar | soar "; then exit 1; else exit 0; fi'
99
ExecStart=/bin/soar update

modules/soar/soar.tsp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ model SoarModuleV1 {
1919
/** Defines how often the `soar` upgrade service should run. The string is passed directly to `OnUnitInactiveSec` in systemd timer. (Syntax: ['1d', '6h', '10m']). */
2020
`upgrade-interval`?: string = "8h";
2121

22-
/** Whether to enable the additional `pkgcache` repo, to enable the support for GUI applications (mostly consisted of AnyLinux-AppImages). */
22+
/** This is a placeholder option which currently does nothing, as it was used before when there were multiple available repos. It may be repurposed to be used in the future. */
2323
`additional-repos`?: boolean = false;
2424

2525
}

0 commit comments

Comments
 (0)