aboutsummaryrefslogtreecommitdiff
path: root/README.md
AgeCommit message (Collapse)Author
2022-02-03first draft of the easier to use install README0neGal
2022-01-20added contact/support information to README0neGal
2022-01-18added proper crediting0neGal
2022-01-12fix "soon" text for mod support, and added previewv1.0.00neGal
A preview of the new UI that is...
2022-01-08fixed wrong link for releasesv0.9.20neGal
I originally tested out having an issues link instead, but went away from the idea and managed to forget to change the link.
2022-01-08fixed/changed the README drastically0neGal
I somehow completely forgot to remove the "coming soon" parts for auto-updating and official releases and download pages, that's now fixed. And since we have that I also moved and changed some text in the "How to run" section renaming it to "Development" Besides that I added Viper's logo along with a link to the projects page for a nice overview and releases page, even tho it is in fact in the sidebar, you may miss it somehow. Given I've removed the application preview we no longer have to keep updating it everytime some change, changes how the app looks on startup. Overall much needed changes to the README.
2022-01-01chore: Auto updating (#16)Rémy Raes
* [chore] adding electron-updater dependency * [feat] adding auto-updating mechanism * [chore] setting package version to v0.8.0 * [fix] restoring original repo URL * [docs] adding some documentation about publishing new releases * [chore] adding publish:windows command * [docs] updating publish instructions with new publish command * [chore] adding publish:linux command * [docs] updating publish instructions * --updatevp, and option to disable auto updates If you want you can set "autoupdates" to false in your config, no GUI tools to do this yet. For the CLI auto updates is off by default and you'll have to use --updatevp. I also removed the snap package, tho whether this stays as a change is still to be discussed. And with the new option I updated the help menu, the man page and everything along else that needs it. * removed "soon" parts of README for auto-updates * [feat] adding French translation for cli.help.updatevp key * confirmation for restarting the app Now instead of automatically updating and restarting the app, which may be slightly confusing to some users, (the app opens then closes and then opens), it now asks whether you want to restart and open the new version. If you say no, instead next time you launch it, it'll be on the new version. If you want to completely disable updates you can disable it in the viper.json file... * [feat] adding French translation for gui.update.available key * added configuration instruction in README Co-authored-by: 0neGal <mail@0negal.com>
2022-01-01added a section for existing launchers0neGal
2021-12-31chore: Build formats (#15)v0.9.0Rémy Raes
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>
2021-12-31add mods and auto-update under features0neGal
2021-12-30added note about building Viper in README0neGal
2021-12-28Merge branch 'main' into feat/iconAlystrasz
2021-12-28[docs] Imply is mentioned as artist in the readmeAlystrasz
2021-12-28[docs] updating readmeAlystrasz
2021-12-27added npm script for building package0neGal
Said script builds an AppImage and an NSIS Installer for Windows. I may make an AppX build as well, that way you can install it straight from your browser very neatly...
2021-12-27rewording in README.md0neGal
2021-12-27finally a README.md0neGal