Skip to content

Commit

Permalink
Add documentation about the new Arch package (closes #605)
Browse files Browse the repository at this point in the history
  • Loading branch information
filips123 committed Dec 31, 2024
1 parent 9f245e6 commit ced7a5a
Show file tree
Hide file tree
Showing 11 changed files with 38 additions and 43 deletions.
2 changes: 1 addition & 1 deletion .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ more beneficial to be translated.
<details>
<summary>Expand localization status</summary>

[![Localization status](https://badges.awesome-crowdin.com/translation-13220281-466834.png)](https://crowdin.com/project/firefoxpwa)
[![Localization Status](https://badges.awesome-crowdin.com/translation-13220281-466834.png)](https://crowdin.com/project/firefoxpwa)
</details>

### Extension Translations
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ labels: bug
* Operating system:
* System architecture:
* Desktop environment: <!-- If on Linux -->
* Installation method: <!-- MSI/DEB/RPM/AUR/source... -->
* Installation method: <!-- MSI/DEB/RPM/Arch/Gentoo/source/... -->
* PWAsForFirefox extension version:
* PWAsForFirefox native version:
* PWAsForFirefox runtime version:
Expand Down
4 changes: 3 additions & 1 deletion docs/docs/installation/requirements.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@
* Windows (pre-built MSI installer)
* Debian-like Linux (pre-built DEB package)
* Red Hat-like Linux (pre-built RPM package)
* Arch-like Linux (source and binary AUR packages)
* Arch-like Linux (package in `[extra]` repository)
* Gentoo-like Linux (ebuild in GURU overlay)
* NixOS Linux (nixpkgs package)
* Other Linux (source installation only)
* macOS (bottled Homebrew formula)
* BSD (source installation only)[^4]
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/user-guide/console.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ The project also provides shell completion files for Bash, Elvish, Fish, PowerSh

On Windows, all completions are installed into the `completions` directory in your
chosen installation directory, but you need to manually load them into your shell.
When using DEB or RPM packages or installing the package from Homebrew or AUR,
When using DEB or RPM packages or installing the package from Homebrew or Arch,
completions for Bash, Fish, and Zsh are automatically installed into required
directories and loaded by shells.

Expand Down
20 changes: 6 additions & 14 deletions extension/src/_locales/en/messages.json
Original file line number Diff line number Diff line change
Expand Up @@ -417,8 +417,8 @@
"description": "The Red Hat (RPM) tab on the instructions page"
},
"instructionsPageTabArch": {
"message": "Arch-like Linux (AUR)",
"description": "The Arch (AUR) tab on the instructions page"
"message": "Arch-like Linux",
"description": "The Arch tab on the instructions page"
},
"instructionsPageTabGentoo": {
"message": "Gentoo-like Linux",
Expand Down Expand Up @@ -584,17 +584,9 @@
"message": "Private NPM registry and Maven, RPM, DEB, PyPi and RubyGem Repository · packagecloud",
"description": "An alternative text for the packagecloud.io logo"
},
"instructionsPageLinuxAurInstallStep1": {
"message": "Download and install one of PWAsForFirefox AUR packages:",
"description": "The step 1 of the Linux AUR installation option"
},
"instructionsPageLinuxAurInstallSource": {
"message": "source",
"description": "The source AUR package"
},
"instructionsPageLinuxAurInstallPreBuilt": {
"message": "pre-built",
"description": "The pre-built AUR package"
"instructionsPageLinuxArchInstallStep1": {
"message": "Install the package using pacman:",
"description": "The step 1 of the Arch Linux installation option"
},
"instructionsPageLinuxGentooInstallStep1": {
"message": "Enable Gentoo GURU overlay using eselect:",
Expand Down Expand Up @@ -625,7 +617,7 @@
"description": "The step 3 of the NixOS installation option"
},
"instructionsPageLinuxNixOSInstallNotice": {
"message": "The package currently needs to be installed from nixos/nixpkgs unstable channel.",
"message": "It is recommended to install the package from the nixos/nixpkgs unstable channel.",
"description": "The unstable channel notice for the NixOS installation option"
},
"instructionsPageMacOSInstallStep1": {
Expand Down
4 changes: 2 additions & 2 deletions extension/src/_locales/id/messages.json
Original file line number Diff line number Diff line change
Expand Up @@ -212,8 +212,8 @@
"description": "The Red Hat (RPM) tab on the instructions page"
},
"instructionsPageTabArch": {
"message": "Linux berbasis Arch (AUR)",
"description": "The Arch (AUR) tab on the instructions page"
"message": "Linux berbasis Arch",
"description": "The Arch tab on the instructions page"
},
"instructionsPageTabGentoo": {
"message": "Linux berbasis Gentoo",
Expand Down
4 changes: 2 additions & 2 deletions extension/src/_locales/ja/messages.json
Original file line number Diff line number Diff line change
Expand Up @@ -292,8 +292,8 @@
"description": "The Red Hat (RPM) tab on the instructions page"
},
"instructionsPageTabArch": {
"message": "Arch 系 Linux (AUR)",
"description": "The Arch (AUR) tab on the instructions page"
"message": "Arch 系 Linux",
"description": "The Arch tab on the instructions page"
},
"instructionsPageTabGentoo": {
"message": "Gentoo 系 Linux",
Expand Down
4 changes: 2 additions & 2 deletions extension/src/_locales/zh-CN/messages.json
Original file line number Diff line number Diff line change
Expand Up @@ -228,8 +228,8 @@
"description": "The Red Hat (RPM) tab on the instructions page"
},
"instructionsPageTabArch": {
"message": "Arch系Linux(AUR)",
"description": "The Arch (AUR) tab on the instructions page"
"message": "Arch系Linux",
"description": "The Arch tab on the instructions page"
},
"instructionsPageTabGentoo": {
"message": "Gentoo系Linux",
Expand Down
4 changes: 2 additions & 2 deletions extension/src/_locales/zh-TW/messages.json
Original file line number Diff line number Diff line change
Expand Up @@ -216,8 +216,8 @@
"description": "The Red Hat (RPM) tab on the instructions page"
},
"instructionsPageTabArch": {
"message": "Arch系Linux(AUR)",
"description": "The Arch (AUR) tab on the instructions page"
"message": "Arch系Linux",
"description": "The Arch tab on the instructions page"
},
"instructionsPageTabGentoo": {
"message": "Gentoo系Linux",
Expand Down
12 changes: 3 additions & 9 deletions extension/src/setup/instructions.html
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<button class="nav-link" id="windows-install-tab" data-bs-toggle="tab" data-bs-target="#windows-install-pane" type="button" role="tab" aria-controls="windows-install-pane" aria-selected="false" data-i18n="instructionsPageTabWindows"></button>
<button class="nav-link" id="linux-deb-install-tab" data-bs-toggle="tab" data-bs-target="#linux-deb-install-pane" type="button" role="tab" aria-controls="linux-deb-install-pane" aria-selected="false" data-i18n="instructionsPageTabDebian"></button>
<button class="nav-link" id="linux-rpm-install-tab" data-bs-toggle="tab" data-bs-target="#linux-rpm-install-pane" type="button" role="tab" aria-controls="linux-rpm-install-pane" aria-selected="false" data-i18n="instructionsPageTabRedHat"></button>
<button class="nav-link" id="linux-aur-install-tab" data-bs-toggle="tab" data-bs-target="#linux-aur-install-pane" type="button" role="tab" aria-controls="linux-aur-install-pane" aria-selected="false" data-i18n="instructionsPageTabArch"></button>
<button class="nav-link" id="linux-arch-install-tab" data-bs-toggle="tab" data-bs-target="#linux-arch-install-pane" type="button" role="tab" aria-controls="linux-arch-install-pane" aria-selected="false" data-i18n="instructionsPageTabArch"></button>
<button class="nav-link" id="linux-gentoo-install-tab" data-bs-toggle="tab" data-bs-target="#linux-gentoo-install-pane" type="button" role="tab" aria-controls="linux-gentoo-install-pane" aria-selected="false" data-i18n="instructionsPageTabGentoo"></button>
<button class="nav-link" id="linux-nixos-install-tab" data-bs-toggle="tab" data-bs-target="#linux-nixos-install-pane" type="button" role="tab" aria-controls="linux-nixos-install-pane" aria-selected="false" data-i18n="instructionsPageTabNixOS"></button>
<button class="nav-link" id="macos-install-tab" data-bs-toggle="tab" data-bs-target="#macos-install-pane" type="button" role="tab" aria-controls="macos-install-pane" aria-selected="false" data-i18n="instructionsPageTabMacOS"></button>
Expand Down Expand Up @@ -126,15 +126,9 @@
</div>
</div>

<div class="tab-pane fade" id="linux-aur-install-pane" role="tabpanel" aria-labelledby="linux-rpm-install-tab">
<div class="tab-pane fade" id="linux-arch-install-pane" role="tabpanel" aria-labelledby="linux-rpm-install-tab">
<ol>
<li>
<span data-i18n="instructionsPageLinuxAurInstallStep1"></span>
<ul>
<li><a href="https://aur.archlinux.org/packages/firefox-pwa/" target="_blank"><kbd>firefox-pwa</kbd></a> (<span data-i18n="instructionsPageLinuxAurInstallSource"></span>)</li>
<li><a href="https://aur.archlinux.org/packages/firefox-pwa-bin/" target="_blank"><kbd>firefox-pwa-bin</kbd></a> (<span data-i18n="instructionsPageLinuxAurInstallPreBuilt"></span>)</li>
</ul>
</li>
<li><span data-i18n="instructionsPageLinuxArchInstallStep1"></span> <kbd>sudo pacman -S firefoxpwa</kbd></li>
<li data-i18n="instructionsPageAfterPackageInstalled"></li>
</ol>
</div>
Expand Down
23 changes: 15 additions & 8 deletions native/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@ Read [the main README file](../README.md) for more details about the project.
* Windows (pre-built MSI installer)
* Debian-like Linux (pre-built DEB package)
* Red Hat-like Linux (pre-built RPM package)
* Arch-like Linux (source and binary AUR packages)
* Gentoo-like Linux (GURU ebuild)
* Arch-like Linux (package in `[extra]` repository)
* Gentoo-like Linux (ebuild in GURU overlay)
* NixOS Linux (nixpkgs package)
* Other Linux (source installation only)
* macOS (bottled Homebrew formula)
Expand All @@ -44,21 +44,28 @@ Thanks to [packagecloud.io](https://packagecloud.io/) for sponsoring this projec
<details>
<summary>Expand packaging status</summary>

[![Packaging status](https://repology.org/badge/vertical-allrepos/firefoxpwa.svg)](https://repology.org/project/firefoxpwa/versions)
[![Packaging Status](https://repology.org/badge/vertical-allrepos/firefoxpwa.svg)](https://repology.org/project/firefoxpwa/versions)
</details>

> [!NOTE]
> If you want to package PWAsForFirefox for your distribution or package manager, or have already packaged it, please let me know, so I can help with the packaging and list it in the installation instructions. If the packaging platform supports any auto-submission/uploading feature, please also let me know, as I might integrate it directly with GitHub Actions to make sure the packages are always up-to-date.
##### Windows

* Windows Package Manager: `filips.FirefoxPWA`
* Chocolatey: [`firefoxpwa`](https://community.chocolatey.org/packages/firefoxpwa)
* Npackd: [`firefoxpwa`](https://www.npackd.org/p/firefoxpwa)
* Scoop: [`extras/firefoxpwa`](https://scoop.sh/#/apps?q=firefoxpwa&id=5361097c7301cc92340840a5f3970aca9220100d)
* Homebrew: [`firefoxpwa`](https://formulae.brew.sh/formula/firefoxpwa)
* Arch User Repository: [`firefox-pwa`](https://aur.archlinux.org/packages/firefox-pwa/) (source)
* Arch User Repository: [`firefox-pwa-bin`](https://aur.archlinux.org/packages/firefox-pwa-bin/) (pre-built)

##### Linux

* Arch: [`firefoxpwa`](https://archlinux.org/packages/extra/x86_64/firefoxpwa/)
* Gentoo GURU: [`www-plugins/firefoxpwa`](https://gpo.zugaina.org/Overlays/guru/www-plugins/firefoxpwa)
* Nixpkgs Unstable: [`firefoxpwa`](https://search.nixos.org/packages?channel=unstable&show=firefoxpwa)

> [!NOTE]
> If you want to package PWAsForFirefox for your distribution or package manager, or have already packaged it, please let me know, so I can help with the packaging and list it in the installation instructions. If the packaging platform supports any auto-submission/uploading feature, please also let me know, as I might integrate it directly with GitHub Actions to make sure the packages are always up-to-date.
##### macOS

* Homebrew: [`firefoxpwa`](https://formulae.brew.sh/formula/firefoxpwa)

### From Release Binaries

Expand Down

0 comments on commit ced7a5a

Please sign in to comment.