SarasasChipWorkshop/sarasacw-picture
1
0
Fork 0
Code Activity

doc: update README

Browse Source
This commit is contained in:
yyc12345
2026-09-27 20:30:17 +08:00
parent 361b083a1d
commit c772e20e67
3 changed files with 88 additions and 138 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+26 -50
View File
@@ -1,86 +1,62 @@
# Sarasas Chip Workshop Picture
Yet another legacy Windows Photo Viewer with cross-platform support.
> [!IMPORTANT]
> SarasaCW Picture are still in refactoring. Please do not use it until this message removes.
Yet another legacy Windows Photo Viewer with cross-platform support.
[![](https://github.com/SarasasChipWorkshop/sarasacw-picture/actions/workflows/windows.yml/badge.svg)](https://github.com/SarasasChipWorkshop/sarasacw-picture/actions/workflows/windows.yml)
[![](https://github.com/SarasasChipWorkshop/sarasacw-picture/actions/workflows/macos.yml/badge.svg)](https://github.com/SarasasChipWorkshop/sarasacw-picture/actions/workflows/macos.yml)
[![](https://github.com/SarasasChipWorkshop/sarasacw-picture/actions/workflows/ubuntu.yml/badge.svg)](https://github.com/SarasasChipWorkshop/sarasacw-picture/actions/workflows/ubuntu.yml)
<!--
TODO: Add main window illustration in future.
![SarasaCW Picture - Main Window](https://repository-images.githubusercontent.com/211888654/e8697600-e370-11eb-9b2a-b71e05262954)
-->
## Summary
Sarasas Chip Workshop Picture (abbr. SarasaCW Picture) is a lightweight image viewer that has cross-platform support and similar user interface about legacy Windows Photo Viewer. It allows you view JPEG, PNG, GIF, SVG, PSD, KRA, XCF, TGA, HDR, AVIF and some other frequently used image formats files quickly and easily without changing your long-term Windows usage experience.
SarasaCW Picture is the **hard fork** of [Pineapple Pictures](https://github.com/BLumia/pineapple-pictures) since Pineapple Pictures 1.4.1 version.
<!--
## Installation
|CI|Build Status|
|---|---|
|Windows Build|[![Windows CI](https://github.com/BLumia/pineapple-pictures/actions/workflows/windows.yml/badge.svg)](https://github.com/BLumia/pineapple-pictures/actions/workflows/windows.yml)|
|macOS Build|[![macOS CI](https://github.com/BLumia/pineapple-pictures/actions/workflows/macos.yml/badge.svg)](https://github.com/BLumia/pineapple-pictures/actions/workflows/macos.yml)|
|Ubuntu Build|[![Ubuntu CI](https://github.com/BLumia/pineapple-pictures/actions/workflows/ubuntu.yml/badge.svg)](https://github.com/BLumia/pineapple-pictures/actions/workflows/ubuntu.yml)|
Download from the places maintained by the author of this repository:
![Pineapple Pictures - Main Window](https://repository-images.githubusercontent.com/211888654/e8697600-e370-11eb-9b2a-b71e05262954)
## Get it!
### Maintained by the original author
- [GitHub Release Page](https://github.com/BLumia/pineapple-pictures/releases)
- [SourceForge](https://sourceforge.net/projects/pineapple-pictures/)
- Archlinux AUR: [pineapple-pictures](https://aur.archlinux.org/packages/pineapple-pictures/) | [pineapple-pictures-git](https://aur.archlinux.org/packages/pineapple-pictures-git/)
- [Itch.io Store](https://blumia.itch.io/pineapple-pictures)
- [Microsoft Store](https://apps.microsoft.com/store/detail/9MXGX66VVGJP)
- Flatpak (on FlatHub): [net.blumia.pineapple-pictures](https://flathub.org/apps/net.blumia.pineapple-pictures) *([Should I use the flatpak version?](https://github.com/BLumia/pineapple-pictures/wiki/Container%E2%80%90based-Packaging-Solutions-Support))*
### Maintained by contributors / certain distro's package maintainers
[![Packaging status](https://repology.org/badge/vertical-allrepos/pineapple-pictures.svg?columns=4)](https://repology.org/project/pineapple-pictures/versions)
- [GitHub Release Page](https://github.com/SarasasChipWorkshop/sarasacw-picture/releases)
## Contribution
Beside feedback and code contribution, other contributions are also welcome!
The new feature request of this application are freezed now because this application basically is a replica of legacy Windows Photo Viewer with additional cross-platform support. However, bug report and translation are welcome.
### Help Translation!
[Translate this project on Weblate!](https://hosted.weblate.org/projects/pineapple-pictures/)
### Funding
[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/blumia)
[![Afdian](https://static.afdiancdn.com/static/img/logo/logo.png)Afdian](https://afdian.com/a/BLumia)
## Build it manually:
## Build Instruction
Current state, we need:
- `cmake`: as the build system.
- `qt6` with `qt6-svg` and `qt6-tools`: since the app is using Qt.
- `libexiv2`: able to display more image metadata. (optional, but recommended)
- `cmake`: as the build system.
- `python3`, `uv` and [`metaglot`](https://github.com/SarasasChipWorkshop/metaglot): as the metadata localization processor.
- `qt6` with `qt6-svg` and `qt6-tools`: since the app is using Qt.
- `libexiv2`: able to display more image metadata. (optional, but recommended)
Then we can build it with any proper c++ compiler like g++ or msvc.
Then we can build it with any proper C++ compiler like g++ or MSVC.
Building it just requires normal cmake building steps:
``` bash
```bash
$ mkdir build && cd build
$ cmake ..
$ cmake --build . # or simply using `make` if you are using Makefile as the cmake generator.
$ cmake --build .
```
After that, a `ppic` executable file will be available to use. You can also optionally install it by using the target `install` (or simply `make install` in case you are using Makefile). After the build process, you can also use `cpack` to make a package.
After that, a `scwpic` executable file will be available to use. You can also optionally install it by using the target `install`. After the build process, you can also use `cpack` to make a package.
The project will try to build with `exiv2` when it's available at build time, if you would like to build the project without `exiv2`, pass `-DEXIV2_METADATA_SUPPORT=OFF` to `cmake`. The project will also not use `exiv2` if it's not found, the `EXIV2_METADATA_SUPPORT` option can be useful if you have `exiv2` but specifically don't want to use it.
Image formats supports rely on Qt's imageformats plugins, just get the plugins you need from your distro's package manager will be fine. For Windows user, you may need build and install the imageformats plugin manually, read the content below.
It's possible to build it under Windows, Linux, macOS, and maybe other desktop platforms that Qt is ported to. For platform specific build instructions, please read the [related wiki page](https://github.com/BLumia/pineapple-pictures/wiki/Platform-Specific-Build-Instructions).
> [!NOTE]
> Although there is a `pineapple-pictures.pro` file which can be used for QMake build, it's only for testing purpose and it doesn't have `exiv2` support included. Using QMake to build this project is NOT supported, please use CMake if possible.
It's possible to build it under Windows, Linux, macOS, and maybe other desktop platforms that Qt is ported to.
## License
Pineapple Pictures as a whole is licensed under MIT license. Individual files may have a different, but compatible license.
-->
SarasaCW Picture as a whole is licensed under MIT license. Individual files may have a different, but compatible license.