docs: update readme

fixes #108
This commit is contained in:
PancakeTAS 2025-07-20 15:51:10 +02:00
parent dd5190aa68
commit 1f8b024807
No known key found for this signature in database

View file

@ -1,16 +1,18 @@
# lsfg-vk
This project brings [Lossless Scaling's Frame Generation](https://store.steampowered.com/app/993090/Lossless_Scaling/) to Linux!
>[!NOTE]
> The latest few commits replace the traditional environment system with a config file. Read [this wiki page](https://github.com/PancakeTAS/lsfg-vk/wiki/Configuring-lsfg%E2%80%90vk) for more information.
>[!CAUTION]
> **This is a work-in-progress**. While frame generation has worked in quite a few games, compatibility in many games as well as frame pacing issues still need to be fixed.
You can install lsfg-vk by running this in your command line:
You can install lsfg-vk by running this in your command line. Always be careful when copy pasting commands from the internet:
```bash
curl -sSf https://pancake.gay/lsfg-vk.sh | sh
```
<sup>Note: This script is extremely primitive and will not work on all distros. It has been written for Arch Linux and its derivations</sup>
Please see the [Wiki](https://github.com/PancakeTAS/lsfg-vk/wiki) for more information and join the [Discord](https://discord.gg/losslessscaling) for help (In order to see the linux channels, verify your Steam account.)
>[!WARNING]
> Please do not open GitHub issues for anything other than feature requests. Due to the nature of this project, it is much easier to deal with issues through Discord, than GitHub. Use the #linux-reports channel for game compatibility.
> **Please do not open GitHub** issues for anything other than feature requests. Due to the nature of this project, it is much easier to deal with issues through Discord, than GitHub. Use the #linux-reports channel for game compatibility.