ChaoticByte/Fragmented
1
1
Fork 0
Code Issues 2 Pull requests Projects Releases 1 Packages Wiki Activity Actions

Readme: add a toc, add a Known Issues section and add a note about screen scaling not being supported (issue #45)

Browse source
This commit is contained in:
ChaoticByte 2025-01-24 21:44:41 +01:00
parent dc325d3e77
commit acdb52c91e
No known key found for this signature in database
1 changed files with 14 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -5,6 +5,14 @@
<p align=center>Create image filters by writing shaders.</p> <p align=center>Create image filters by writing shaders.</p>
## Table of Contents
- [Supported Platforms](#supported-platforms)
- [Usage](#usage)
- [Shaderlib](#shaderlib)
- [Commandline interface](#commandline-interface)
- [Known Issues](#known-issues)
## Supported Platforms ## Supported Platforms
- Linux - Linux
@ -106,3 +114,9 @@ You can also run `./Fragmented cmd help` to show the help message.
``` ```
./Fragmented cmd --shader ./examples/oklab.gdshader --load-image ~/Pictures/test.png --output ./output.png ./Fragmented cmd --shader ./examples/oklab.gdshader --load-image ~/Pictures/test.png --output ./output.png
``` ```
## Known Issues
- screen scaling is unsupported; Using screen scaling could lead to an either blurry UI, or no scaling at all -> see #45
- the shaderlib API is still unstable, this will change with version 10
- commandline interface: `--headless` is not supported