diff options
| author | Rémy Raes <contact@remyraes.com> | 2021-12-31 17:20:46 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-12-31 17:20:46 +0100 |
| commit | cd0a935a85dde412dad0f0f201c8384feaf4ff7b (patch) | |
| tree | e5d04acee0db42ab8f14a26d8f082c3930e25357 /README.md | |
| parent | ba82a7e8e5bc90705649c859674caeb334996b81 (diff) | |
| download | Viper-cd0a935a85dde412dad0f0f201c8384feaf4ff7b.tar.gz Viper-cd0a935a85dde412dad0f0f201c8384feaf4ff7b.zip | |
chore: Build formats (#15)v0.9.0
Adds more build formats and info in the README
* [feat] adding build:windows command
* [fix] typo
* [feat] adding build:linux command
* [docs] adding enduser documentation to explain how to install Viper
* [feat] building several Linux packages on build:linux
* [fix] typo on build command
* minor corrections
Co-authored-by: 0neGal <mail@0negal.com>
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 16 |
1 files changed, 14 insertions, 2 deletions
@@ -24,14 +24,26 @@ This'll launch it with the Electron build installed by `npm`. Additionally, if you really want to, you can build Viper with `npm run build` and it'll then build the Windows installer and AppImage, however the whole build process and everything related to it is still being worked on which is why we don't have official releases yet. +## Install + +(this will be relevant once we start to publish releases) + +Downloads are available on the [releases page](https://github.com/0neGal/viper/releases/latest). + +Please note that some versions will (*[soon™](https://github.com/0neGal/viper/tree/auto-updates)*) update themselves automatically when a new release is available (just like Origin or Steam) and some will NOT, so choose it accordingly. Only the AppImage and Windows Setup/Installer can auto-update. + +**Windows:** `Viper Setup [x.y.z].exe` (auto-updates, and is recommanded), `Viper [x.y.z].exe` (single executable, no fuss) + +**Linux:** `.AppImage` (auto-updates), `.deb`, `.rpm`, `.snap`, `.tar.gz` + ## What can it do specifically? Currently Viper is capable of: * Updating/Installing Northstar * Launching Vanilla and or Northstar - * Manage Mods (Soon, see **mod-support** branch) - * Auto-Update itself (Soon, see **auto-updater** branch) + * Manage Mods (Soon, see [**mod-support**](https://github.com/0neGal/viper/tree/mod-support) branch) + * Auto-Update itself (Soon, see [**auto-updater**](https://github.com/0neGal/viper/tree/auto-updates) branch) * Be pretty! Besides this I've been considering adding some easy to use VPK modding tools so everybody can have fun with VPK modding even if you don't know how to do it the traditional way. However that is not at the top of the todo list right now. |