Files
sarasacw-picture/README.md
T

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

63 lines
3.4 KiB
Markdown
Raw Normal View History

2026-07-02 11:03:35 +08:00
# Sarasas Chip Workshop Picture
> [!IMPORTANT]
> SarasaCW Picture are still in refactoring. Please do not use it until this message removes.
2026-09-27 20:28:34 +08:00
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)
-->
2026-07-02 11:03:35 +08:00
## 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.
2026-09-27 20:28:34 +08:00
## Installation
2024-04-25 23:19:42 +08:00
2026-09-27 20:28:34 +08:00
Download from the places maintained by the author of this repository:
2024-04-25 23:19:42 +08:00
2026-09-27 20:28:34 +08:00
- [GitHub Release Page](https://github.com/SarasasChipWorkshop/sarasacw-picture/releases)
2024-04-25 23:19:42 +08:00
## Contribution
2026-09-27 20:28:34 +08:00
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.
2026-09-27 20:28:34 +08:00
## Build Instruction
2024-04-25 23:19:42 +08:00
Current state, we need:
2026-09-27 20:28:34 +08:00
- `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)
2024-04-25 23:19:42 +08:00
2026-09-27 20:28:34 +08:00
Then we can build it with any proper C++ compiler like g++ or MSVC.
2024-04-25 23:19:42 +08:00
Building it just requires normal cmake building steps:
2026-09-27 20:28:34 +08:00
```bash
2024-04-25 23:19:42 +08:00
$ mkdir build && cd build
$ cmake ..
2026-09-27 20:28:34 +08:00
$ cmake --build .
2024-04-25 23:19:42 +08:00
```
2026-09-27 20:28:34 +08:00
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.
2024-04-25 23:19:42 +08:00
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.
2026-09-27 20:28:34 +08:00
It's possible to build it under Windows, Linux, macOS, and maybe other desktop platforms that Qt is ported to.
2024-04-25 23:19:42 +08:00
## License
2026-09-27 20:28:34 +08:00
SarasaCW Picture as a whole is licensed under MIT license. Individual files may have a different, but compatible license.