Skip to content

Commit c45b4b5

Browse files
committed
docs: reorganize readme for better user flow
1 parent b89c9f8 commit c45b4b5

1 file changed

Lines changed: 24 additions & 21 deletions

File tree

README.md

Lines changed: 24 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,9 @@
99
<p align="center">
1010
<b>Everything you love, engineered for speed. User-centric. Native. Powerful. </b>
1111
</p>
12+
13+
<p align="center"><a href="https://github.com/SnapXL/SnapX"><img src="./.github/Screenshot.webp" alt="SnapX Interface" /></a></p>
14+
1215
<br>
1316
<div align="center">
1417
<a href="https://github.com/SnapXL/SnapX/actions/workflows/build.yml">
@@ -52,7 +55,6 @@
5255
</a>
5356
</div>
5457
<br>
55-
<p align="center"><a href="https://github.com/SnapXL/SnapX"><img src="./.github/Screenshot.webp" alt="SnapX Interface" /></a></p>
5658

5759
> [!CAUTION]
5860
> SnapX is in **_Early Access_**.
@@ -67,26 +69,6 @@
6769

6870
> [1] When tested on KDE Plasma Wayland 6.2.90 with HDR, the resulting screenshots' colors were not blown out. Your mileage may vary.
6971
70-
## Technical Details
71-
72-
- It uses [.NET 10](https://learn.microsoft.com/en-us/dotnet/core/whats-new/dotnet-10/overview), [ImageSharp](https://docs.sixlabors.com/articles/imagesharp/?tabs=tabid-1) (cross-platform image library).
73-
- It uses [SQLite](https://www.sqlite.org/about.html) for [image metadata like image hashes & history](https://github.com/SnapXL/SnapX/issues/28).
74-
- UI is GPU-accelerated, leading to a more responsive UI & yet less CPU usage while navigating the UI. (Fixes low performance on 4K screens with a weak CPU).
75-
- Respects [XDG directory specification](https://specifications.freedesktop.org/basedir-spec/latest/), Symlinks ~/Documents/SnapX to respective config/data directory on Linux/macOS.
76-
- Uses [Direct3D11](https://learn.microsoft.com/en-us/windows/win32/direct2d/comparing-direct2d-and-gdi) & [WinRT](https://learn.microsoft.com/en-us/windows/apps/develop/platform/csharp-winrt/) to capture on Windows, [XCap](https://github.com/nashaofu/xcap) on macOS, and [XDG Portals](https://flatpak.github.io/xdg-desktop-portal/) on Linux.
77-
- Supports PNG (including animated variant), WEBP (including animated variant), AVIF, JPEG, GIFs (should be smaller than your typical ShareX GIF), TIFF, and BMP image formats.
78-
- Supports 95% of ShareX uploaders (we're a fork!).
79-
- The ability to fully configure SnapX via the Command Line via command flags & environment variables. Additionally, you can configure SnapX using the Windows Registry.
80-
- Keeps compatibility with the custom uploader configuration format (.sxcu).
81-
- As a user, you do **NOT** need to have .NET installed. Whether you're on Linux, Windows, macOS, or FreeBSD.
82-
83-
[//]: # (- Supports Google Photos Image Uploader after the [new API change]&#40;https://developers.googleblog.com/en/google-photos-picker-api-launch-and-library-api-updates/&#41;.)
84-
85-
What does this all mean? It means you'll be able to have a more **performant**, **reliable**, and **stylish** application.
86-
87-
You will *not* receive any support from the ShareX project for this software. \
88-
If you have any issues with this project or would like us to add any new feature, please **open an issue** in this repository or use the [`#development`](https://discord.com/channels/1267996919922430063/1404876855861051562) channel in our [Discord](https://discord.gg/ys3ZCzttVQ).
89-
9072
## Supported Desktop Environments
9173

9274
This application relies on XDG portals to handle screenshots in a secure and desktop-agnostic way. It is actively tested on:
@@ -118,6 +100,27 @@ SnapX is packaged on:
118100

119101
Additionally, you can download nightly builds from [here](https://nightly.link/SnapXL/SnapX/workflows/build/develop?preview).
120102

103+
104+
## Technical Details
105+
106+
- It uses [.NET 10](https://learn.microsoft.com/en-us/dotnet/core/whats-new/dotnet-10/overview), [ImageSharp](https://docs.sixlabors.com/articles/imagesharp/?tabs=tabid-1) (cross-platform image library).
107+
- It uses [SQLite](https://www.sqlite.org/about.html) for [image metadata like image hashes & history](https://github.com/SnapXL/SnapX/issues/28).
108+
- UI is GPU-accelerated, leading to a more responsive UI & yet less CPU usage while navigating the UI. (Fixes low performance on 4K screens with a weak CPU).
109+
- Respects [XDG directory specification](https://specifications.freedesktop.org/basedir-spec/latest/), Symlinks ~/Documents/SnapX to respective config/data directory on Linux/macOS.
110+
- Uses [Direct3D11](https://learn.microsoft.com/en-us/windows/win32/direct2d/comparing-direct2d-and-gdi) & [WinRT](https://learn.microsoft.com/en-us/windows/apps/develop/platform/csharp-winrt/) to capture on Windows, [XCap](https://github.com/nashaofu/xcap) on macOS, and [XDG Portals](https://flatpak.github.io/xdg-desktop-portal/) on Linux.
111+
- Supports PNG (including animated variant), WEBP (including animated variant), AVIF, JPEG, GIFs (should be smaller than your typical ShareX GIF), TIFF, and BMP image formats.
112+
- Supports 95% of ShareX uploaders (we're a fork!).
113+
- The ability to fully configure SnapX via the Command Line via command flags & environment variables. Additionally, you can configure SnapX using the Windows Registry.
114+
- Keeps compatibility with the custom uploader configuration format (.sxcu).
115+
- As a user, you do **NOT** need to have .NET installed. Whether you're on Linux, Windows, macOS, or FreeBSD.
116+
117+
[//]: # (- Supports Google Photos Image Uploader after the [new API change]&#40;https://developers.googleblog.com/en/google-photos-picker-api-launch-and-library-api-updates/&#41;.)
118+
119+
What does this all mean? It means you'll be able to have a more **performant**, **reliable**, and **stylish** application.
120+
121+
You will *not* receive any support from the ShareX project for this software. \
122+
If you have any issues with this project or would like us to add any new feature, please **open an issue** in this repository or use the [`#development`](https://discord.com/channels/1267996919922430063/1404876855861051562) channel in our [Discord](https://discord.gg/ys3ZCzttVQ).
123+
121124
## Building & Contributing
122125

123126
Contributions are welcome.

0 commit comments

Comments
 (0)