Skip to content

Commit d727b8a

Browse files
committed
docs: completely revamp readme
1 parent fcfc0aa commit d727b8a

5 files changed

Lines changed: 242 additions & 46 deletions

File tree

.github/Screenshot.png

-81.1 KB
Binary file not shown.

.github/Screenshot.webp

37.7 KB
Loading

README.md

Lines changed: 240 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1,93 +1,120 @@
1-
<p align="center"><a href="https://github.com/SnapXL/SnapX"><img src="./.github/Linux.png" alt="SnapX Banner"/></a></p>
1+
<p align="center">
2+
<a href="https://github.com/SnapXL/SnapX">
3+
<img src="./.github/Linux.png" alt="SnapX Banner" />
4+
</a>
5+
</p>
26
<h1 align="center">SnapX</h1>
37
<h3 align="center">Capture, share, and boost productivity. All in one.</h3>
8+
<h3 align="center">Built on the foundations of <a href="https://getsharex.com">ShareX</a>, made cross-platform. </h3>
9+
<p align="center">
10+
<b>Everything you love, engineered for speed. User-centric. Native. Powerful. </b>
11+
</p>
412
<br>
513
<div align="center">
6-
<a href="https://github.com/SnapXL/SnapX/actions/workflows/build.yml"><img src="https://img.shields.io/github/actions/workflow/status/SnapXL/SnapX/build.yml?branch=develop&label=Build&cacheSeconds=3600" alt="GitHub Workflow Status"/></a>
7-
<a href="./LICENSE.md"><img src="https://img.shields.io/github/license/SnapXL/SnapX?label=License&color=brightgreen&cacheSeconds=3600" alt="License"/></a>
8-
<a href="https://github.com/SnapXL/SnapX/releases/latest"><img src="https://img.shields.io/github/v/release/SnapXL/SnapX?label=Release&color=brightgreen&cacheSeconds=3600" alt="Release"/></a>
9-
<a href="https://github.com/SnapXL/SnapX/releases/latest"><img src="https://img.shields.io/github/downloads/SnapXL/SnapX/total?label=Downloads&cacheSeconds=3600" alt="Downloads"/></a>
14+
<a href="https://github.com/SnapXL/SnapX/actions/workflows/build.yml">
15+
<img src="https://badgen.net/github/checks/SnapXL/SnapX/develop?label=Build" alt="GitHub Workflow Status" />
16+
</a>
17+
<a href="./LICENSE.md">
18+
<img src="https://badgen.net/github/license/SnapXL/SnapX?color=green" alt="License" />
19+
</a>
20+
<a href="https://github.com/SnapXL/SnapX/releases/latest">
21+
<img src="https://badgen.net/github/release/SnapXL/SnapX?label=Release&color=green" alt="Release" />
22+
</a>
23+
<a href="https://github.com/SnapXL/SnapX/releases/latest">
24+
<img src="https://badgen.net/github/assets-dl/SnapXL/SnapX?label=Downloads&color=green" alt="Downloads" />
25+
</a>
1026
<br>
1127
<br>
12-
<a href="https://aur.archlinux.org/pkgbase/snapx"><img src="https://raw.githubusercontent.com/ok-coder1/devins-badges-contrib/refs/heads/v3/assets/compact/available/aur_vector.svg" height="40" alt="AUR Package Base"/></a>
13-
<a href="https://github.com/BrycensRanch/homebrew-repo"><img src="https://raw.githubusercontent.com/ok-coder1/devins-badges-contrib/refs/heads/v3/assets/compact/available/homebrew_vector.svg" height="40" alt="My Homebrew Tap"/></a>
28+
<a href="https://aur.archlinux.org/pkgbase/snapx">
29+
<img src="https://raw.githubusercontent.com/ok-coder1/devins-badges-contrib/refs/heads/v3/assets/compact/available/aur_vector.svg" height="40" alt="AUR Package Base" />
30+
</a>
31+
<a href="https://github.com/BrycensRanch/homebrew-repo">
32+
<img src="https://raw.githubusercontent.com/ok-coder1/devins-badges-contrib/refs/heads/v3/assets/compact/available/homebrew_vector.svg" height="40" alt="My Homebrew Tap" />
33+
</a>
34+
<a href="https://snapcraft.io/ui-snapx">
35+
<img src="https://img.shields.io/badge/Available on Snapcraft-E95420?style=flat&logo=snapcraft&logoColor=white&labelColor=5E2750" height="40" width="244" alt="Get it from the Snap Store" />
36+
</a>
37+
<a href="https://github.com/SnapXL/SnapX/wiki/Adding-DEB-RPM-repository">
38+
<img src="https://img.shields.io/badge/RPMs%2FDEBs_repository-51A2DA?style=flat&logo=linux&logoColor=white&labelColor=294172" height="40" Width="244" alt="Get it from our repository" />
39+
</a>
40+
<a href="https://nightly.link/SnapXL/SnapX/workflows/build/develop?preview">
41+
<img src="https://img.shields.io/badge/Flatpak available-51A2DA?style=flat&logo=flatpak&logoColor=white&labelColor=294172" height="40" Width="244" alt="Get it from our repository" />
42+
</a>
1443
<br>
15-
<a href="https://discord.gg/ys3ZCzttVQ"><img src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/compact/social/discord-singular_vector.svg" height="40" alt="Discord"/></a>
16-
<a href="https://ko-fi.com/BrycensRanch"><img src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/compact/donate/kofi-singular_vector.svg" height="40" alt="Support me on Ko-fi"/></a>
17-
<a href="https://paypal.me/BrycensRanch"><img src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/compact/donate/paypal-singular_vector.svg" height="40" alt="Support me on PayPal"/></a>
44+
<a href="https://discord.gg/ys3ZCzttVQ">
45+
<img src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/compact/social/discord-singular_vector.svg" height="40" alt="Discord" />
46+
</a>
47+
<a href="https://ko-fi.com/BrycensRanch">
48+
<img src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/compact/donate/kofi-singular_vector.svg" height="40" alt="Support me on Ko-fi" />
49+
</a>
50+
<a href="https://paypal.me/BrycensRanch">
51+
<img src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/compact/donate/paypal-singular_vector.svg" height="40" alt="Support me on PayPal" />
52+
</a>
1853
</div>
1954
<br>
20-
<p align="center"><a href="https://github.com/SnapXL/SnapX"><img src="./.github/Screenshot.png" alt="GitHub Repository"/></a></p>
55+
<p align="center"><a href="https://github.com/SnapXL/SnapX"><img src="./.github/Screenshot.webp" alt="SnapX Interface" /></a></p>
2156

2257
> [!CAUTION]
23-
> **This project is _under development_ and is _not_ ready for use.**
24-
25-
> [!NOTE]
26-
> **DISCLAIMER:** SnapX is a [hard fork](https://producingoss.com/en/forks.html) of the Windows application [ShareX](https://github.com/ShareX/ShareX).
58+
> SnapX is in **_Early Access_**.
59+
> The core capture and upload engine is stable and ready for daily use. However, the Image Editor is still in the works.
2760
2861
## Feature-wise
2962

30-
- SnapX is a cross-platform application.
31-
- Elegance in user interfaces by separating essential settings from advanced or intermediate functionality
63+
[//]: # (- Elegance in user interfaces by separating essential settings from advanced or intermediate functionality)
3264
- Supporting high DPI screens
3365
- Screenshots on an HDR monitor aren't blown out<sup>[1]</sup>
34-
- Cross-platform OCR powered by [**PaddleOCR**](https://github.com/PaddlePaddle/PaddleOCR) for industry-leading precision. Experience accuracy that [**outperforms**](https://github.com/opendatalab/OmniDocBench?tab=readme-ov-file#end-to-end-evaluation) PowerToys OCR, ShareX, Tesseract, and Window's built in OCR.
66+
- Cross-platform OCR powered by [**PaddleOCR**](https://github.com/PaddlePaddle/PaddleOCR) for industry-leading precision. Experience accuracy that [**outperforms**](https://intuitionlabs.ai/articles/non-llm-ocr-technologies#paddleocr--industrial-grade-deep-ocr-baidu) PowerToys OCR, ShareX, Tesseract, and Window's built in OCR.
3567

3668
> [1] When tested on KDE Plasma Wayland 6.2.90 with HDR, the resulting screenshots' colors were not blown out. Your mileage may vary.
3769
3870
## Technical Details
3971

4072
- 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).
4173
- It uses [SQLite](https://www.sqlite.org/about.html) for [image metadata like image hashes & history](https://github.com/SnapXL/SnapX/issues/28).
42-
- The UI is now defined in a more modern, declarative style using MVVM and XAML, providing a clear improvement over the older WinForms approach.
4374
- 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).
4475
- Respects [XDG directory specification](https://specifications.freedesktop.org/basedir-spec/latest/), Symlinks ~/Documents/SnapX to respective config/data directory on Linux/macOS.
4576
- 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.
4677
- 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.
4778
- Supports 95% of ShareX uploaders (we're a fork!).
48-
- Supports Google Photos Image Uploader after the [new API change](https://developers.googleblog.com/en/google-photos-picker-api-launch-and-library-api-updates/).
4979
- The ability to fully configure SnapX via the Command Line via command flags & environment variables. Additionally, you can configure SnapX using the Windows Registry.
50-
- Additionally, all uploaders are now encouraged to use HTTPS <2.0 & *optionally* use TLS 1.3.
5180
- Keeps compatibility with the custom uploader configuration format (.sxcu).
5281
- As a user, you do **NOT** need to have .NET installed. Whether you're on Linux, Windows, macOS, or FreeBSD.
5382

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+
5485
What does this all mean? It means you'll be able to have a more **performant**, **reliable**, and **stylish** application.
5586

5687
You will *not* receive any support from the ShareX project for this software. \
5788
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).
5889

59-
## Supported Linux Distributions
60-
61-
This project is built on Ubuntu 24.04 and is tested on the following distributions:
62-
63-
- **Fedora 42+** <img src="https://upload.wikimedia.org/wikipedia/commons/thumb/4/41/Fedora_icon_%282021%29.svg/960px-Fedora_icon_%282021%29.svg.png" alt="Fedora Logo" height="25" width="25"/>
64-
- **Ubuntu 24.04+** <img src="https://upload.wikimedia.org/wikipedia/commons/thumb/9/94/Ubuntu_logoib.svg/960px-Ubuntu_logoib.svg.png" alt="Ubuntu Logo" height="25" width="25"/>
65-
66-
> [!NOTE]
67-
> If you're using a different distribution, there will be a Flatpak package available when possible. If you're using a distribution that doesn't support Flatpak, you can [build the project from source](#building-from-source).
68-
6990
## Supported Desktop Environments
7091

7192
This application relies on XDG portals to handle screenshots in a secure and desktop-agnostic way. It is actively tested on:
7293

7394
- **KDE Plasma**
7495
- **GNOME**
7596

76-
> [!TIP]
77-
> Other desktop environments or Wayland compositors—such as Budgie, Cinnamon, MATE, Hyprland, and any others that implement the necessary screenshot portal—should also work, but are not officially tested.
97+
We also use direct X11 screenshot capture on X based environments.
7898

79-
## Testing
99+
> [!TIP]
100+
> Other desktop environments or Wayland compositors, like Budgie, Cinnamon, MATE, Hyprland, and any others that have the right screenshot portal, should work, but they haven't been officially tested.
80101
81-
SnapX is not yet in a usable state. Packages are provided for making testing easier.
102+
## Packaging
82103

83-
See our guide here to learn [how to test](https://github.com/SnapXL/SnapX/wiki/Testing).
104+
See our quick start testing guide here to learn [how to test](https://github.com/SnapXL/SnapX/wiki/Testing) SnapX.
84105

85106
SnapX is packaged on:
86107

87-
- [AUR](https://aur.archlinux.org/packages/snapx-ui)
88108
<!-- - [Flathub](https://flathub.org/en/apps/io.github.SnapXL.SnapX) [PENDING] -->
89-
- [My Homebrew Tap](https://github.com/BrycensRanch/homebrew-repo)
90-
- [Snapcraft](https://snapcraft.io/ui-snapx)
109+
110+
- **AUR:** [`snapx-ui`](https://aur.archlinux.org/packages/snapx-ui)
111+
- **Snapcraft:** [`ui-snapx`](https://snapcraft.io/ui-snapx)
112+
- **Homebrew:** [BrycensRanch/homebrew-repo](https://github.com/BrycensRanch/homebrew-repo)
113+
- **DEB/RPM Repo:** [Setup Instructions](https://github.com/SnapXL/SnapX/wiki/Adding-DEB-RPM-repository)
114+
115+
**Flatpak** (Flathub pending)
116+
- **x86_64:** [Download](https://nightly.link/SnapXL/SnapX/workflows/build/develop/io.github.SnapXL.SnapX-x86_64.flatpak)
117+
- **aarch64:** [Download](https://nightly.link/SnapXL/SnapX/workflows/build/develop/io.github.SnapXL.SnapX-aarch64.flatpak)
91118

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

@@ -98,13 +125,182 @@ See [BUILDING.md](./.github/BUILDING.md) for build instructions.
98125

99126
The documentation for contributing can be found [here](./.github/CONTRIBUTING.md).
100127

101-
## Donators 💖
128+
## 🤝 Real People. Real Code. Soul. 💖
129+
130+
Free-range, organic, non-GMO, and locally sourced developers. This code was created without causing any damage to any GPUs.
102131

103-
- [Rsslone (Tommy)](https://github.com/Rsslone)
104-
- [Skorlok](https://github.com/Skorlok)
105-
- [Abdullah16M](https://github.com/Abdullah16M)
132+
<div align="center">
133+
<h3>👨‍💻 Espresso Consortium</h3>
134+
<p><em>Turning caffeine into code, and bugs into features.</em></p>
135+
<p>The architects, packagers, documentation writers, debuggers, and morning birds currently building SnapX.</p>
136+
<table border="0">
137+
<tr>
138+
<td align="center" width="150">
139+
<a href="https://github.com/BrycensRanch">
140+
<b>BrycensRanch (Lead)</b>
141+
<br>
142+
<img src="https://github.com/BrycensRanch?size=100" width="85" style="border-radius:50%">
143+
</a>
144+
</td>
145+
<td align="center" width="150">
146+
<a href="https://github.com/ok-coder1">
147+
<b>ok-coder1 (Team)</b>
148+
<br>
149+
<img src="https://github.com/ok-coder1.png?size=100" width="85" style="border-radius:50%">
150+
</a>
151+
</td>
152+
<td align="center" width="150">
153+
<a href="https://github.com/Rune580">
154+
<b>Rune580</b>
155+
<br>
156+
<img src="https://github.com/Rune580.png?size=100" width="85" style="border-radius:50%">
157+
</a>
158+
</td>
159+
<td align="center" width="150">
160+
<a href="https://github.com/norz3n">
161+
<b>norz3n</b>
162+
<br>
163+
<img src="https://github.com/norz3n.png?size=100" width="85" style="border-radius:50%">
164+
</a>
165+
</td>
166+
</tr>
167+
</table>
168+
</div>
169+
170+
<div align="center">
171+
<h3>💸 The Caffeine & Infrastructure Cartel</h3>
172+
<p>These charitable people support our early morning server maintenance and coding sessions. Their donations literally keeps the lights on and the compilers warm.</p>
173+
174+
<table border="0">
175+
<tr>
176+
<td align="center" width="150">
177+
<a href="https://github.com/Rsslone">
178+
<b>Rsslone (Tommy)</b>
179+
<br>
180+
<img src="https://github.com/Rsslone.png?size=100" width="85" style="border-radius:50%">
181+
</a>
182+
</td>
183+
<td align="center" width="150">
184+
<a href="https://github.com/Skorlok">
185+
<b>Skorlok</b>
186+
<br>
187+
<img src="https://github.com/Skorlok.png?size=100" width="85" style="border-radius:50%">
188+
</a>
189+
</td>
190+
<td align="center" width="150">
191+
<a href="https://github.com/Abdullah16M">
192+
<b>Abdullah16M</b>
193+
<br>
194+
<img src="https://github.com/Abdullah16M.png?size=100" width="85" style="border-radius:50%">
195+
</a>
196+
</td>
197+
</tr>
198+
</table>
199+
<a href="https://github.com/sponsors/BrycensRanch">
200+
<img alt="GitHub Sponsors" src="https://img.shields.io/github/sponsors/BrycensRanch?logo=github&logoColor=pink&label=GitHub Sponsors">
201+
</a>
202+
<a href="https://liberapay.com/BrycensRanch">
203+
<img src="https://badgen.net/liberapay/receives/BrycensRanch?label=Liberapay" alt="Liberapay Receive Badge" />
204+
</a>
205+
<a href="https://ko-fi.com/BrycensRanch">
206+
<img src="https://badgen.net/badge/KoFi/Buy%20me%20a%20coffee/ff5f5f?icon=kofi" alt="Ko-fi" />
207+
</a>
208+
</div>
209+
210+
<br>
211+
212+
<div align="center">
213+
<h3>🔬 Battle-tested by a select few</h3>
214+
<p>Our code isn't compiled. It's <strong>dry-aged</strong>.</p>
215+
<p>"Hallucinated" bug fixes are not what we do. We use a more conventional approach: look at a stack trace until someone breaks down in tears.</p>
216+
<p>SnapX was built by the brave ones who wiped their eyes…<br>and kept clicking.</p>
217+
<table border="0">
218+
<tr>
219+
<td align="center" width="120">
220+
<a href="https://discord.com/users/164445443680370688">
221+
<b>Horo</b>
222+
<br>
223+
<img src="https://cdn.discordapp.com/avatars/164445443680370688/c3903fec7b8194538f361f07f8158dc3.webp?size=80" width="70" style="border-radius:50%">
224+
</a>
225+
</td>
226+
<td align="center" width="120">
227+
<a href="https://discord.com/users/182579271095681024">
228+
<b>Freako95</b>
229+
<br>
230+
<img src="https://cdn.discordapp.com/avatars/182579271095681024/6d06b134101abdee90f324ce9bd5728a.webp?size=80" width="70" style="border-radius:50%">
231+
</a>
232+
</td>
233+
<td align="center" width="120">
234+
<a href="https://discord.com/users/182674215424622592">
235+
<b>トミー (tommy.sama)</b>
236+
<br>
237+
<img src="https://cdn.discordapp.com/avatars/182674215424622592/a_702f394eb560bfb04fa64aaf371720cd.gif?size=80&animated=true" width="70" style="border-radius:50%">
238+
</a>
239+
</td>
240+
<td align="center" width="120">
241+
<a href="https://discord.com/users/224868029610197002">
242+
<b>Tobi</b>
243+
<br>
244+
<img src="https://cdn.discordapp.com/avatars/224868029610197002/b25365f9df561c83ea39c948f561ffd4.webp?size=80" width="70" style="border-radius:50%">
245+
</a>
246+
</td>
247+
<td align="center" width="120">
248+
<a href="https://discord.com/users/277518977033437185">
249+
<b>Skorlok</b>
250+
<br>
251+
<img src="https://cdn.discordapp.com/avatars/277518977033437185/967acee9feb87a326dc8a98e32514912.webp?size=80" width="70" style="border-radius:50%">
252+
</a>
253+
</td>
254+
</tr>
255+
<tr>
256+
<td align="center" width="120">
257+
<a href="https://discord.com/users/354370875878801419">
258+
<b>Tape1</b>
259+
<br>
260+
<img src="https://cdn.discordapp.com/avatars/354370875878801419/6b2cdd67625303b8991b08e2ef76d906.webp?size=80" width="70" style="border-radius:50%">
261+
</a>
262+
</td>
263+
<td align="center" width="120">
264+
<a href="https://discord.com/users/362670720972619777">
265+
<b>Ione 15</b>
266+
<br>
267+
<img src="https://cdn.discordapp.com/avatars/362670720972619777/9f722e792194a1728d356c7af79de67c.webp?size=80" width="70" style="border-radius:50%">
268+
</a>
269+
</td>
270+
<td align="center" width="120">
271+
<a href="https://discord.com/users/474221560031608833">
272+
<b>Lee</b>
273+
<br>
274+
<img src="https://cdn.discordapp.com/avatars/474221560031608833/8e447f29d00eb191cb0421fe4e91273e.webp?size=80" width="70" style="border-radius:50%">
275+
</a>
276+
</td>
277+
<td align="center" width="120">
278+
<a href="https://discord.com/users/615785223296253953">
279+
<b>Tari</b>
280+
<br>
281+
<img src="https://cdn.discordapp.com/avatars/615785223296253953/44ac4c5c337af5cc827ae6e9ca091ea6.webp?size=80" width="70" style="border-radius:50%">
282+
</a>
283+
</td>
284+
<td align="center" width="120">
285+
<a href="https://discord.com/users/677619920657317936">
286+
<b>revolume</b>
287+
<br>
288+
<img src="https://cdn.discordapp.com/avatars/677619920657317936/bbd30a5d9c1876c53f391fdd7a4d138a.webp?size=80" width="70" style="border-radius:50%">
289+
</a>
290+
</td>
291+
</tr>
292+
<tr>
293+
<td align="center" width="120">
294+
<a href="https://discord.com/users/821472922140803112">
295+
<b>Luna</b>
296+
<br>
297+
<img src="https://cdn.discordapp.com/avatars/821472922140803112/09023e78e4afe943e440806188f77539.webp?size=80" width="70" style="border-radius:50%">
298+
</a>
299+
</td>
300+
</tr>
301+
</table>
302+
</div>
106303

107-
**Thank you so much!** People like you are the reason why this project is possible. For anyone interested in financially contributing, donate via [Liberapay](https://liberapay.com/BrycensRanch)!
108304

109305
## Roadmap
110306

0 commit comments

Comments
 (0)