Skip to content

Commit

Permalink
Merge pull request #1635 from erri120/docs/update-install
Browse files Browse the repository at this point in the history
Update docs
  • Loading branch information
erri120 authored Jun 18, 2024
2 parents 60cb480 + 72c6246 commit f670a05
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 44 deletions.
38 changes: 0 additions & 38 deletions docs/developers/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,39 +16,6 @@

If you want to know how the App works, see [Mod With Confidence](./ModWithConfidence.md).

## Installation

### Windows

**Requirements**: Windows 10 or newer and a x64 CPU, we don't support Windows on ARM.

Download and run the [Windows Installer] from the [latest release] on GitHub.

### Linux

The App requires the following programs to be available at runtime:

- `xdg-open` to open URLs in your browser.
- `update-desktop-database` to update the MIME cache after creating a desktop entry file for the NXM link handler.

#### AppImage

You can download the AppImage file `NexusMods.App.x86_64.AppImage` from the [latest release] on GitHub. Make sure you have the following dependencies installed before running the AppImage:

- [FUSE 2](https://github.com/AppImage/AppImageKit/wiki/FUSE) is required to run any AppImage.
- `glibc` 2.2.5 or newer
- `glibc++` 3.4 or newer

#### System Package Manager

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

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

### macOS

We currently don't publish releases for macOS.

## The Team

### Nexus Mods App Team
Expand All @@ -70,8 +37,3 @@ See [Contributors](https://github.com/Nexus-Mods/NexusMods.App/graphs/contributo
Former maintainers:

- [TanninOne](https://github.com/TanninOne): Creator of [Vortex](https://www.nexusmods.com/about/vortex/) and [Mod Organizer 1](https://github.com/TanninOne/modorganizer).

---

[Windows Installer]: https://github.com/Nexus-Mods/NexusMods.App/releases/latest/download/NexusMods.App.x64.exe
[latest release]: https://github.com/Nexus-Mods/NexusMods.App/releases/latest
22 changes: 18 additions & 4 deletions docs/users/GettingStarted.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,25 @@
!!! warning "Important Notice"
The Nexus Mods app is still in development and is not recommend to be used as your primary mod manager. For the latest supporter mod manager please see [Vortex](https://staticdelivery.nexusmods.com/mods/2295/images/thumbnails/1/1-1690272155-1455020317.png).

Before installing the app, please ensure that your PC meets the system requirements for both [this app](./SystemRequirements.md) and the game you are modding.
Before installing the app, please ensure that your PC meets the system requirements for both [the App](./SystemRequirements.md) and the game you are modding.

## Installation

Download the latest version of the app and run the installer on your system.
### Windows

- [Windows Installer](https://github.com/Nexus-Mods/NexusMods.App/releases/latest/download/NexusMods.App.x64.exe)
- [Linux AppImage](https://github.com/Nexus-Mods/NexusMods.App/releases/latest)
Download and run the [Windows Installer] from the [latest release] on GitHub.

### Linux

#### AppImage

You can download the AppImage from the [latest release] on GitHub. Make sure you have [FUSE 2](https://github.com/AppImage/AppImageKit/wiki/FUSE) installed before running it.

#### System Package Manager

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

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

[Windows Installer]: https://github.com/Nexus-Mods/NexusMods.App/releases/latest/download/NexusMods.App.x64.exe
[latest release]: https://github.com/Nexus-Mods/NexusMods.App/releases/latest
4 changes: 2 additions & 2 deletions docs/users/SystemRequirements.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,17 +7,17 @@ This page lists the recommended system requirements to install and run the app o

* Windows 10 or 11

## Linux dependencies
## Linux
The App requires the following programs to be available at runtime:

- `xdg-open` to open URLs in your browser.
- `update-desktop-database` to update the MIME cache after creating a desktop entry file for the NXM link handler.

If you plan to install using the AppImage, make sure you have the following dependencies installed:

- [FUSE 2](https://github.com/AppImage/AppImageKit/wiki/FUSE) is required to run any AppImage.
- `glibc` 2.2.5 or newer
- `glibc++` 3.4 or newer
- [FUSE 2](https://github.com/AppImage/AppImageKit/wiki/FUSE) is required if you want to run the AppImage.

## macOS

Expand Down

0 comments on commit f670a05

Please sign in to comment.