Skip to content

Commit 6f3464c

Browse files
dumbmoronwukko
dumbmoron
and
wukko
authored
readme: add deb/rpm and contributing info, rephrase, refactor (#233)
Co-authored-by: wukko <me@wukko.me>
1 parent ac03686 commit 6f3464c

2 files changed

Lines changed: 94 additions & 14 deletions

File tree

‎README.md‎

Lines changed: 78 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,68 @@
11
# helium-linux
2-
Portable Linux (`.AppImage`) packaging for [Helium](https://github.com/imputnet/helium).
2+
Linux builds, packaging, and development tooling for the
3+
[Helium Browser](https://github.com/imputnet/helium).
4+
5+
## Downloads
6+
Helium is available in multiple formats depending on your distribution.<br>
7+
We offer builds for `x86_64/amd64` and `arm64/aarch64` platforms.
8+
9+
> [!NOTE]
10+
> Packaging not listed here is not officially maintained and should be
11+
> used with extreme caution.
12+
13+
### Fedora
14+
1. Enable [Helium COPR](https://copr.fedorainfracloud.org/coprs/imput/helium/):
15+
```bash
16+
sudo dnf copr enable imput/helium
17+
```
18+
19+
1. Install Helium:
20+
```bash
21+
sudo dnf install helium-bin
22+
```
23+
24+
### Debian/Ubuntu
25+
1. Add Helium's signing public key:
26+
```bash
27+
curl -fsSL https://raw.githubusercontent.com/imputnet/helium-linux/main/pubkey.asc | sudo gpg --dearmor -o /usr/share/keyrings/helium.gpg
28+
```
29+
30+
1. Add Helium's repo:
31+
```bash
32+
echo "deb [signed-by=/usr/share/keyrings/helium.gpg] https://pkg.helium.computer/deb stable main" | sudo tee /etc/apt/sources.list.d/helium.list
33+
```
34+
For prerelease builds, replace `stable` with `prerelease`
35+
36+
1. Update apt lists and install Helium:
37+
```bash
38+
sudo apt update && sudo apt install helium-bin
39+
```
40+
41+
### AppImage and binary tarball
42+
[Download the latest release on GitHub](https://github.com/imputnet/helium-linux/releases/latest)
43+
44+
### Flatpak/Flathub
45+
We will not support Flatpak as long as it's impossible to package Chromium
46+
without [breaking its sandbox](https://discuss.privacyguides.net/t/does-flatpak-weaken-chromium-firefoxs-sandbox/13373/7).
47+
We recommend that you use AppImage if an official distro package isn't
48+
available.
349

450
## Credits
5-
This repo is based on
51+
52+
### Depot
53+
Big thank you to [Depot](https://depot.dev/) for sponsoring our runners,
54+
which handle the Linux builds of Helium. Their high-performance infrastructure
55+
lets us compile, package, and release new builds of Helium within hours,
56+
not days.
57+
58+
### ungoogled-chromium
59+
This repo uses some stuff that originally came from
660
[ungoogled-chromium-portablelinux](https://github.com/ungoogled-software/ungoogled-chromium-portablelinux)
7-
and modified for Helium. Huge shout-out to everyone behind ungoogled-chromium,
8-
they made working with Chromium infinitely easier.
61+
before we fully remade it and forked it for Helium.
962

10-
Big thank you to [Depot](https://depot.dev/) for sponsoring our runners, which handle the Linux
11-
builds of Helium. Their high-performance infrastructure lets us compile, package, and release
12-
new builds of Helium within hours, not days.
63+
## Contributing
64+
Before contributing to this repo, please read the guidelines in main repo's
65+
[CONTRIBUTING.md](https://github.com/imputnet/helium/blob/main/CONTRIBUTING.md).
1366
1467
## License
1568
All code, patches, modified portions of imported code or patches, and
@@ -24,23 +77,34 @@ licensed under their [BSD 3-Clause license](LICENSE.ungoogled_chromium)).
2477
To build the binary, run `scripts/docker-build.sh` from the repo root.
2578
2679
The `scripts/docker-build.sh` script will:
27-
1. Create a Docker image of a Debian-based building environment with all required packages (llvm, nodejs and distro packages) included.
80+
1. Create a Docker image of a Debian-based building environment with all
81+
required packages (llvm, nodejs and distro packages) included.
2882
2. Run `scripts/build.sh` inside the Docker image to build Helium.
2983
30-
Running `scripts/build.sh` directly will not work unless you're running a Debian-based distro and have all necessary dependencies installed. This repo is designed to avoid having to configure the building environment on your Linux installation.
84+
Running `scripts/build.sh` directly will not work unless you're running a
85+
Debian-based distro and have all necessary dependencies installed. This repo is
86+
designed to avoid having to configure the building environment on your Linux
87+
installation.
3188

3289
### Packaging
33-
After building, run `scripts/package.sh`. Alternatively, you can run `package/docker-package.sh` to build inside a Docker image. Either of these scripts will create `tar.xz` and `AppImage` files under `build/`.
90+
After building, run `scripts/package.sh`. Alternatively, you can run
91+
`package/docker-package.sh` to build inside a Docker image. Either of these
92+
scripts will create `tar.xz` and `AppImage` files under `build/`.
3493

35-
If you would like to also generate a .deb file, you can set `MAKE_DEB=1` when running the release script.
94+
If you would like to also generate a .deb file, you can set `MAKE_DEB=1` when
95+
running the release script.
3696

3797
### Development
38-
By default, the build script uses tarball. If you need to use a source tree clone, you can run `scripts/docker-build.sh -c` instead. This may be useful if a tarball for a release isn't available yet.
98+
By default, the build script uses tarball. If you need to use a source tree
99+
clone, you can run `scripts/docker-build.sh -c` instead. This may be useful if
100+
a tarball for a release isn't available yet.
39101
40102
### Signature
41-
AppImage builds (since [0.5.7.1](https://github.com/imputnet/helium-linux/releases/tag/0.5.7.1))
42-
and binary tarballs (since [0.7.7.2](https://github.com/imputnet/helium-linux/releases/tag/0.7.7.2))
103+
AppImage builds (since [0.5.7.1](https://github.com/imputnet/helium-linux/releases/tag/0.5.7.1)),
104+
binary tarballs (since [0.7.7.2](https://github.com/imputnet/helium-linux/releases/tag/0.7.7.2)),
105+
and the .deb repository (since [0.10.7.1](https://github.com/imputnet/helium-linux/releases/tag/0.10.7.1))
43106
are signed with the following key:
107+
44108
```
45109
-----BEGIN PGP PUBLIC KEY BLOCK-----
46110
Comment: BE67 7C19 89D3 5EAB 2C5F 26C9 3516 01AD 01D6 378E

‎pubkey.asc‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
-----BEGIN PGP PUBLIC KEY BLOCK-----
2+
Comment: BE67 7C19 89D3 5EAB 2C5F 26C9 3516 01AD 01D6 378E
3+
Comment: Helium signing key (https://helium.computer/)
4+
5+
xjMEaOqhEBYJKwYBBAHaRw8BAQdA+0OK9OgI98hQGR0ZI5aVuXxdeDU+6eyLiKhH
6+
4pwAaH7NQEhlbGl1bSBzaWduaW5nIGtleSAoaHR0cHM6Ly9oZWxpdW0uY29tcHV0
7+
ZXIvKSA8aGVsaXVtQGltcHV0Lm5ldD7CmQQTFgoAQRYhBL5nfBmJ016rLF8myTUW
8+
Aa0B1jeOBQJo6qEQAhsDBQkFo5qABQsJCAcCAiICBhUKCQgLAgQWAgMBAh4HAheA
9+
AAoJEDUWAa0B1jeO31AA/0w52qczu5T4w0miS3up03c4uIJtdw2MfHFLIEAQN7T2
10+
AP9ZI9ozR7C2/isB0GLeQM6o10DGiXGNA0T2kmNEJqIXC844BGjqoRASCisGAQQB
11+
l1UBBQEBB0AoNTUK0xOCCMLTWO1Nvhe9el/bNuyTyMmincD7hXu5JwMBCAfCfgQY
12+
FgoAJhYhBL5nfBmJ016rLF8myTUWAa0B1jeOBQJo6qEQAhsMBQkFo5qAAAoJEDUW
13+
Aa0B1jeOLYEA/ReQcxHx9axm3rYYad+1XeQQyiIPCjclCVMyeAXqS5XOAP0RBc9/
14+
md8JlXqOCGwmHuOk3VVkR5EjCgm2KJ8hqdhwBA==
15+
=Chk7
16+
-----END PGP PUBLIC KEY BLOCK-----

0 commit comments

Comments
 (0)