Skip to content

Commit

Permalink
feat: add install guide
Browse files Browse the repository at this point in the history
  • Loading branch information
craftablescience committed Dec 20, 2023
1 parent 55bde11 commit dd4f5bb
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 0 deletions.
35 changes: 35 additions & 0 deletions INSTALL.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Installing VPKEdit

This document covers the different ways you can install VPKEdit on its supported
platforms:

- Windows 10/11 (64-bit)
- Linux (64-bit)

Note: if you wish to *update* the application, simply repeat these steps. This works for
both the standalone method and installer method.

## Windows

1. You will need to install the VS2015-2022 runtime located at https://aka.ms/vs/16/release/vc_redist.x64.exe.
2. When that is installed, download either the standalone version or the installer version from [the latest
GitHub release](https://github.com/craftablescience/VPKEdit/releases/latest), under the `Assets` dropdown.
3. If you downloaded the standalone files, you're done, just unzip the files. If you downloaded the installer,
unzip the installer application and run it. Windows will give you a safety warning, ignore it and hit `Run Anyway`.

## Linux

Installation on Linux will vary depending on your distro. On all distros you should be able to run the standalone
application without any issues. There are two ways of *installing* VPKEdit
specific to the following distros:

#### Debian-based:

1. Download the installer from the GitHub releases section, and extract the `.deb` file from inside.
2. Run `sudo apt install ./<name of deb file>.deb` in the directory you extracted it to.

#### Arch-based:

VPKEdit is on the Arch User Repository thanks to [@HurricanePootis](https://github.com/HurricanePootis).
Please consult the [Arch Wiki](https://wiki.archlinux.org/title/Arch_User_Repository) for more information,
as I don't use Arch Linux personally and don't know how that system works. (I use Debian btw)
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ VPKEdit is an open source MIT-licensed tool that can create, extract from, previ

<img src="https://github.com/craftablescience/VPKEdit/blob/main/branding/readme_promo.png?raw=true" alt="A screenshot of VPKEdit with a VTF preview open." />

## Installing

Please read [this file](https://github.com/craftablescience/VPKEdit/blob/main/INSTALL.md) for step-by-step installation instructions.

## Features

- Create VPKs of any version from scratch or an existing folder
Expand Down

0 comments on commit dd4f5bb

Please sign in to comment.