Skip to content

Commit

Permalink
Merge pull request #1647 from erri120/docs/publish
Browse files Browse the repository at this point in the history
Update section for package maintainers
  • Loading branch information
erri120 authored Jun 19, 2024
2 parents d1a5755 + 23cc1a0 commit f68815a
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 1 deletion.
6 changes: 5 additions & 1 deletion docs/developers/Contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,5 +24,9 @@ If you want to create a package for your distribution, here are some helpful tip

- If possible, use `nexusmods-app` for the package name.
- We ship a build of `7zz` and use that executable unless you set `NEXUSMODS_APP_USE_SYSTEM_EXTRACTOR=1` when publishing. See [this issue](https://github.com/Nexus-Mods/NexusMods.App/issues/1306#issuecomment-2095755699) for details.
- Set `INSTALLATION_METHOD_PACKAGE_MANAGER` when publishing. We have an integrated updater that will notify users about new versions. If you set this flag, we'll tell the user to update with their package manager.
- Set `INSTALLATION_METHOD_PACKAGE_MANAGER` when publishing. We have an integrated updater that will notify users about new versions. If you set this flag, we'll tell the user to update the App with their package manager.
- Let us know if you have questions or if you published a new package by joining our [Discord](https://discord.gg/ReWTxb93jS).

We publish the App using [PupNet](https://github.com/kuiperzone/PupNet-Deploy). Releases are built using GitHub Actions, see [`build-linux-pupnet.yaml`](https://github.com/Nexus-Mods/NexusMods.App/blob/main/.github/workflows/build-linux-pupnet.yaml) for details. PupNet will use `dotnet publish` before packaging the result in some specialized format.

If you don't wish to use PupNet, you should still use `dotnet publish` over `dotnet build`. The arguments we use with `dotnet publish` can be found in [`app.pupnet.conf`](https://github.com/Nexus-Mods/NexusMods.App/blob/main/src/NexusMods.App/app.pupnet.conf). Also see the [`dotnet publish` documentation](https://learn.microsoft.com/en-us/dotnet/core/tools/dotnet-publish#options) for a list of options.
2 changes: 2 additions & 0 deletions docs/users/SystemRequirements.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,10 +43,12 @@ In addition, the following libraries are required:
- `glibc++` 3.4 or newer

### Linux Packages

The status of packages for various Linux builds can be seen below:

[![Packaging status](https://repology.org/badge/vertical-allrepos/nexusmods-app.svg)](https://repology.org/project/nexusmods-app/versions)

If you want to create a package for your platform, see [Contributing](../developers/Contributing.md#for-package-maintainers) for more details.

## macOS

Expand Down

0 comments on commit f68815a

Please sign in to comment.