Skip to content

Commit bf3031f

Browse files
committed
♻️ Synced Soar 📦 <-- docs(readme): update readme (pkgforge#27) ⌚
1 parent 0bddad2 commit bf3031f

2 files changed

Lines changed: 37 additions & 23 deletions

File tree

.github/LATEST.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
aff38ec43d6448fc87e9f1e261c551ff7b60270a
1+
8ee5c74828a9c060894a8c6f5bb69e2a786ce353

README.md

Lines changed: 36 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
# Soar
2-
31
<div align="center">
42

53
[crates-shield]: https://img.shields.io/crates/v/soar-cli
@@ -38,14 +36,41 @@
3836
Supports <a href="https://docs.pkgforge.dev/formats/binaries/static">Static Binaries</a>, <a href="https://docs.pkgforge.dev/formats/packages/appimage">AppImages</a>, and other <a href="https://docs.pkgforge.dev/formats/packages">Portable formats</a> on any <a href="https://docs.pkgforge.dev/repositories/soarpkgs/faq#portability">*Unix-based Distro</a>
3937
</p>
4038

39+
# Soar Package Manager
40+
4141
## 🌟 Key Features
4242

43-
- [Distro Agnostic](https://docs.pkgforge.dev/soar/readme/packages#portability) (Read the [Manifesto](https://github.com/pkgforge/soarpkgs/blob/main/MANIFESTO.md))
44-
- [Native Desktop Integration](https://soar.qaidvoid.dev/#desktop-integration)
45-
- [SLSA Build L2 Security Guarantees](https://docs.pkgforge.dev/soar/readme/security)
46-
- [Thousands of Prebuilt Packages](https://pkgs.pkgforge.dev/) ([Soar User Repository](https://github.com/pkgforge/soarpkgs))
47-
- [Universal Package Support](https://soar.qaidvoid.dev/#universal-package-support)
48-
- [& Much More](https://docs.pkgforge.dev/soar/comparisons)
43+
| Feature | Description |
44+
|:--:|:--|
45+
| **Universal Package Format Support** | Soar can install and manage portable package formats including [static binaries](https://docs.pkgforge.dev/formats/binaries/static), [self-extractable archives](https://docs.pkgforge.dev/formats/packages/archive), and [AppImages](https://docs.pkgforge.dev/formats/packages/appimage). |
46+
| **System Integration** | Soar [automatically integrates](https://soar.qaidvoid.dev/#desktop-integration) installed packages with your system to provide a native-like experience. |
47+
| **Flexible Repository System** | While Soar comes preconfigured with [official repositories](https://docs.pkgforge.dev/repositories), you can [configure custom repositories](https://soar.qaidvoid.dev/configuration#custom-repository-support) that use any build format as long as they provide compatible metadata. The `.SBUILD` format is only required for the official repositories, not for custom ones. |
48+
| **Security First** | Soar enforces security through checksums and signing verification for package installations. |
49+
| **External Repository Support** | Soar can access packages from sources like [ivan-hc/AM](https://github.com/ivan-hc/AM) and [appimage.github.io](https://github.com/AppImage/appimage.github.io) through metadata provided by pkgforge. These external sources don't directly work with soar but are made compatible through pkgforge's metadata conversion. **Note:** Packages from external repositories are not verified. |
50+
| **Fast Package Operations** | Soar provides efficient package searching, installation, and management with minimal overhead. |
51+
52+
## 📦 Packages Available Through Official Repositories
53+
54+
Packages in the official Soar repositories have these characteristics:
55+
56+
| Feature | Description |
57+
|:--:|:--|
58+
| **Portable Packages** | Packages are designed to be [portable](https://docs.pkgforge.dev/formats/) across distributions, either through [static linking](https://docs.pkgforge.dev/formats/binaries/static) or by bundling all dependencies. This makes them [distro-agnostic](https://docs.pkgforge.dev/soar/readme/packages#portability). |
59+
| **Extensive Collection** | Official repositories host one of the [largest collections](https://docs.pkgforge.dev/soar/readme/packages#total) of portable packages. Browse them with `soar list` or at [pkgs.pkgforge.dev](https://pkgs.pkgforge.dev/). |
60+
| **Prebuilt Binaries** | 100% of official packages are provided as [prebuilts](https://docs.pkgforge.dev/repositories/soarpkgs/faq#cache), making installation limited only by download speed. |
61+
| **Quality Compilation** | Around 80% of packages are compiled from source with optimizations for performance (LTO), security (ASLR/PIE), and size (MUSL). |
62+
| **High Security Standards** | Official packages are built with [SLSA Build L2 Security Guarantees](https://docs.pkgforge.dev/soar/readme/security). |
63+
| **Community Contributions** | The [`.SBUILD`](https://docs.pkgforge.dev/sbuild/introduction) format in [pkgforge/soarpkgs](https://github.com/pkgforge/soarpkgs) allows community members to submit package definitions, similar to AUR. |
64+
| **Cross-Distro Compatibility** | Some packages are repackaged from other distro repositories, allowing you to run applications from e.g., Arch repositories on Debian-based systems without containers. |
65+
| **Decentralized** | The portable nature of packages means they can be downloaded and used independently of Soar if needed. |
66+
67+
## ☢️ Caveats
68+
#### Soar doesn't reinvent things
69+
Soar isn't a package manager in the traditional sense, neither is it a [new standard](https://xkcd.com/927/), thus soar doesn't handle core system tools/libraries by design.
70+
This means soar is not a replacement for your distro's official package manager.<br>
71+
Instead, Soar complements existing package managers by providing your distro with additional packages or newer version of packages that your distro may not provide.<br>
72+
Soar is meant to coexist with existing package managers by avoiding conflicts, being completely functional in userspace & using XDG Specifications.<br>
73+
For more questions, check our [FAQ](https://docs.pkgforge.dev/repositories/soarpkgs/faq) or [create a discussion](https://github.com/pkgforge/soar/discussions).
4974

5075
## 🔧 Installation
5176

@@ -55,11 +80,8 @@ Soar comes as a single-file, statically-linked executable with no dependencies t
5580

5681
## ⚙️ Configuration
5782

58-
Soar comes with [sane defaults](https://soar.qaidvoid.dev/configuration.html) & [all repositories](https://docs.pkgforge.dev/repositories/) preconfigured at `~/.config/soar/config.toml`<br>
59-
For additional configuration guide, click [here](https://soar.qaidvoid.dev/configuration.html)
60-
> [!NOTE]
61-
> Soar provides [External repositories](https://docs.pkgforge.dev/repositories/external), which aren't enabled by default.
62-
> Enable them with `soar defconfig --external` if you haven't created configuration file yet. Or, add them manually using metadata from [here](https://meta.pkgforge.dev/external/).
83+
Soar comes with [sane defaults](https://soar.qaidvoid.dev/configuration.html) & [official repositories](https://docs.pkgforge.dev/repositories/) preconfigured<br>
84+
For additional configuration guide, see [here](https://soar.qaidvoid.dev/configuration.html)
6385

6486
## 🎯 Usage
6587

@@ -68,15 +90,7 @@ Simply run `soar --help` for general options.
6890
- Detailed guide regarding each format is at: [docs.pkgforge.dev](https://docs.pkgforge.dev/formats/packages)
6991

7092
## 📦 Packages
71-
Our [Official repositories](https://docs.pkgforge.dev/repositories) use a novel recipe format called [`.SBUILD`](https://docs.pkgforge.dev/sbuild/introduction) at [pkgforge/soarpkgs](https://github.com/pkgforge/soarpkgs).
72-
Our CI Infra builds these [packages](https://pkgs.pkgforge.dev/) periodically & syncs to the [cache](https://docs.pkgforge.dev/repositories/soarpkgs/faq#cache).<br>
73-
Additionally we also support [AM](https://github.com/ivan-hc/AM) & [appimage.github.io](https://github.com/AppImage/appimage.github.io) as [external repositories](https://docs.pkgforge.dev/repositories/external)
74-
75-
76-
What Packages are Available?
77-
- Type `soar list` for a list
78-
- Or visit [pkgs.pkgforge.dev](https://pkgs.pkgforge.dev/)<br>
79-
To request new packages or report an issue with an existing one, please use the [pkgforge/soarpkgs](https://github.com/pkgforge/soarpkgs) repository.<br>
93+
For reporting any issues related to packaging, please use our [Official package repository](https://docs.pkgforge.dev/repositories) at [pkgforge/soarpkgs](https://github.com/pkgforge/soarpkgs).<br>
8094

8195
## 💬 Community
8296

0 commit comments

Comments
 (0)