github.com/pojntfx/hydrapp/hydrapp@v0.0.0-20240516002902-d08759d6ca9f/pkg/renderers/docs/INSTALLATION.md.tpl (about)

     1  {{ $appID := .AppID }}
     2  {{ $appName := .AppName }}
     3  
     4  # {{ $appName }} Installation Instructions
     5  
     6  {{ if .RenderAPK }}
     7  ## Android
     8  
     9  1. Download F-Droid from [f-droid.org](https://f-droid.org/)
    10  2. Open F-Droid and go to `Settings`, then `Repositories`
    11  3. Add a new repository by following the instructions at [{{ .AndroidRepoURL }}]({{ .AndroidRepoURL }})
    12  4. Search for `{{ $appName }}` in F-Droid and tap on `Install`
    13  
    14  {{ $appName }} should now be installed and receive updates automatically.
    15  {{ end }}
    16  
    17  {{ range .DEBs }}
    18  
    19  ## {{ Titlecase .DistroName }} {{ Titlecase .DistroVersion }} on `{{ .Architecture }}`
    20  
    21  To install the prebuilt binary package, run the following:
    22  
    23  ```shell
    24  pkexec sudo bash - <<'EOT'
    25  mkdir -p /usr/local/share/keyrings
    26  curl -Lo {{ .URL }}/repo.asc | gpg --dearmor --output /usr/local/share/keyrings/{{ $appID }}.gpg -
    27  
    28  cat >/etc/apt/sources.list.d/{{ $appID }}.list <<EOA
    29  deb [signed-by=/usr/local/share/keyrings/{{ $appID }}.gpg] {{ .URL }} {{ .DistroName }} main
    30  deb-src [signed-by=/usr/local/share/keyrings/{{ $appID }}.gpg] {{ .URL }} {{ .DistroName }} main
    31  EOA
    32  
    33  apt update
    34  
    35  apt install -y '{{ $appID }}'
    36  EOT
    37  ```
    38  
    39  To install the source package, build the binary package locally and install it, run the following:
    40  
    41  ```shell
    42  pkexec sudo bash - <<'EOT'
    43  mkdir -p /usr/local/share/keyrings
    44  curl -Lo {{ .URL }}repo.asc | gpg --dearmor --output /usr/local/share/keyrings/{{ $appID }}.gpg -
    45  
    46  cat >/etc/apt/sources.list.d/{{ $appID }}.list <<EOA
    47  deb [signed-by=/usr/local/share/keyrings/{{ $appID }}.gpg] {{ .URL }} {{ .DistroName }} main
    48  deb-src [signed-by=/usr/local/share/keyrings/{{ $appID }}.gpg] {{ .URL }} {{ .DistroName }} main
    49  EOA
    50  
    51  apt update
    52  
    53  apt install -y dpkg-dev
    54  apt build-dep -y '{{ $appID }}'
    55  apt source -y --build '{{ $appID }}'
    56  apt install -y ./{{ $appID }}_*.deb
    57  EOT
    58  ```
    59  
    60  {{ $appName }} should now be installed and receive updates automatically.
    61  
    62  {{ end }}
    63  
    64  {{ range .RPMs }}
    65  
    66  ## {{ Titlecase .DistroName }} {{ Titlecase .DistroVersion }} on `{{ .Architecture }}`
    67  
    68  To install the prebuilt binary package, run the following:
    69  
    70  ```shell
    71  pkexec sudo bash - <<'EOT'
    72  dnf config-manager --add-repo '{{ .URL }}'
    73  dnf install -y '{{ $appID }}'
    74  EOT
    75  ```
    76  
    77  To install the source package, build the binary package locally and install it, run the following:
    78  
    79  ```shell
    80  pkexec sudo bash - <<'EOT'
    81  dnf config-manager --add-repo '{{ .URL }}'
    82  
    83  dnf install -y rpm-build
    84  dnf download --source -y '{{ $appID }}'
    85  dnf builddep -y {{ $appID }}-*.rpm
    86  rpmbuild --rebuild {{ $appID }}-*.rpm
    87  dnf install -y ~/rpmbuild/RPMS/"$(uname -m)"/{{ $appID }}-*.rpm
    88  EOT
    89  ```
    90  
    91  {{ $appName }} should now be installed and receive updates automatically.
    92  
    93  {{ end }}
    94  
    95  {{ if .RenderDMG }}
    96  ## macOS
    97  
    98  1. Download the `.app` from [{{ .MacOSBinaryURL }}]({{ .MacOSBinaryURL }})
    99  2. Mount `{{ .MacOSBinaryName }}` by opening it
   100  3. Drag `{{ $appName }}` to the `Applications` folder
   101  
   102  {{ $appName }} should now be installed and receive updates automatically.
   103  {{ end }}
   104  
   105  {{ range .Flatpaks }}
   106  
   107  ## Linux Universal (Flatpak) on `{{ .Architecture }}`
   108  
   109  To install the package, run the following:
   110  
   111  ```shell
   112  flatpak remote-add '{{ $appID }}' --from '{{ .URL }}'
   113  flatpak install -y '{{ $appID }}'
   114  ```
   115  
   116  {{ $appName }} should now be installed and receive updates automatically.
   117  {{ end }}
   118  
   119  {{ range .MSIs }}
   120  
   121  ## Windows on `{{ .Architecture }}`
   122  
   123  1. Download the installer from [{{ .URL }}]({{ .URL }})
   124  2. Install the application by opening the downloaded file
   125  
   126  {{ $appName }} should now be installed and receive updates automatically.
   127  
   128  {{ end }}
   129  
   130  {{ if .RenderBinaries }}
   131  ## Other Platforms
   132  
   133  {{ $appName }} is also available as a single static binary. To install it, download the binary for your operating system and processor architecture from [{{ .BinariesURL }}]({{ .BinariesURL }}). They include a self-update mechanism, so you should be receiving updates automatically.
   134  {{ end }}