doc: update README
This commit is contained in:
@@ -1,86 +1,62 @@
|
|||||||
# Sarasas Chip Workshop Picture
|
# Sarasas Chip Workshop Picture
|
||||||
|
|
||||||
Yet another legacy Windows Photo Viewer with cross-platform support.
|
|
||||||
|
|
||||||
> [!IMPORTANT]
|
> [!IMPORTANT]
|
||||||
> SarasaCW Picture are still in refactoring. Please do not use it until this message removes.
|
> 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)
|
||||||
|
[](https://github.com/SarasasChipWorkshop/sarasacw-picture/actions/workflows/macos.yml)
|
||||||
|
[](https://github.com/SarasasChipWorkshop/sarasacw-picture/actions/workflows/ubuntu.yml)
|
||||||
|
|
||||||
|
<!--
|
||||||
|
TODO: Add main window illustration in future.
|
||||||
|
|
||||||
|
-->
|
||||||
|
|
||||||
## Summary
|
## 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.
|
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.
|
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|
|
Download from the places maintained by the author of this repository:
|
||||||
|---|---|
|
|
||||||
|Windows Build|[](https://github.com/BLumia/pineapple-pictures/actions/workflows/windows.yml)|
|
|
||||||
|macOS Build|[](https://github.com/BLumia/pineapple-pictures/actions/workflows/macos.yml)|
|
|
||||||
|Ubuntu Build|[](https://github.com/BLumia/pineapple-pictures/actions/workflows/ubuntu.yml)|
|
|
||||||
|
|
||||||
|
- [GitHub Release Page](https://github.com/SarasasChipWorkshop/sarasacw-picture/releases)
|
||||||
|
|
||||||
## 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
|
|
||||||
|
|
||||||
[](https://repology.org/project/pineapple-pictures/versions)
|
|
||||||
|
|
||||||
## Contribution
|
## 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!
|
## Build Instruction
|
||||||
|
|
||||||
[Translate this project on Weblate!](https://hosted.weblate.org/projects/pineapple-pictures/)
|
|
||||||
|
|
||||||
### Funding
|
|
||||||
|
|
||||||
[](https://ko-fi.com/blumia)
|
|
||||||
|
|
||||||
[Afdian](https://afdian.com/a/BLumia)
|
|
||||||
|
|
||||||
## Build it manually:
|
|
||||||
|
|
||||||
Current state, we need:
|
Current state, we need:
|
||||||
|
|
||||||
- `cmake`: as the build system.
|
- `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.
|
- `qt6` with `qt6-svg` and `qt6-tools`: since the app is using Qt.
|
||||||
- `libexiv2`: able to display more image metadata. (optional, but recommended)
|
- `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:
|
Building it just requires normal cmake building steps:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
$ mkdir build && cd build
|
$ mkdir build && cd build
|
||||||
$ cmake ..
|
$ 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.
|
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.
|
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).
|
It's possible to build it under Windows, Linux, macOS, and maybe other desktop platforms that Qt is ported to.
|
||||||
|
|
||||||
> [!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.
|
|
||||||
|
|
||||||
## License
|
## 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.
|
||||||
|
|
||||||
-->
|
|
||||||
|
|||||||
@@ -0,0 +1,62 @@
|
|||||||
|
# Sarasas Chip Workshop 照片查看器
|
||||||
|
|
||||||
|
> [!IMPORTANT]
|
||||||
|
> SarasaCW 照片查看器还在重构中。在这条信息被移除之前请不要使用它。
|
||||||
|
|
||||||
|
简单轻量的、具有跨平台支持的、经典样式的 Windows 照片查看器。
|
||||||
|
|
||||||
|
[](https://github.com/SarasasChipWorkshop/sarasacw-picture/actions/workflows/windows.yml)
|
||||||
|
[](https://github.com/SarasasChipWorkshop/sarasacw-picture/actions/workflows/macos.yml)
|
||||||
|
[](https://github.com/SarasasChipWorkshop/sarasacw-picture/actions/workflows/ubuntu.yml)
|
||||||
|
|
||||||
|
<!--
|
||||||
|
TODO: Add main window illustration in future.
|
||||||
|
|
||||||
|
-->
|
||||||
|
|
||||||
|
## 简介
|
||||||
|
|
||||||
|
Sarasas Chip Workshop 照片查看器（简称 SarasaCW 照片查看器）是一个轻量级的图片查看器。支持跨平台。界面风格类似于经典的 Windows 照片查看器。它可以让你快速轻松地浏览 JPEG、PNG、GIF、SVG、PSD、KRA、XCF、TGA、HDR、AVIF 以及其他一些常用的图片格式，且无需改变你长期的 Windows 使用习惯。
|
||||||
|
|
||||||
|
SarasaCW 照片查看器是[菠萝看图](https://github.com/BLumia/pineapple-pictures)的**硬分叉**，该分叉自菠萝看图 1.4.1 版本开始。
|
||||||
|
|
||||||
|
## 安装
|
||||||
|
|
||||||
|
从本仓库作者维护的地方下载：
|
||||||
|
|
||||||
|
- [GitHub Release 页面](https://github.com/SarasasChipWorkshop/sarasacw-picture/releases)
|
||||||
|
|
||||||
|
## 参与贡献
|
||||||
|
|
||||||
|
现在已冻结该应用的新功能请求，因为这个应用基本上是经典样式的 Windows 照片查看器的复刻，只是增加了跨平台支持。不过仍然欢迎针对该项目的错误报告和翻译。
|
||||||
|
|
||||||
|
## 构建指导
|
||||||
|
|
||||||
|
当前状态，我们需要先确保如下依赖可用：
|
||||||
|
|
||||||
|
- `cmake`：我们所使用的构建系统
|
||||||
|
- `python3`、`uv` 和 [`metaglot`](https://github.com/SarasasChipWorkshop/metaglot)：我们所使用的元数据本地化处理器
|
||||||
|
- 包含 `qt6-svg` 与 `qt6-tools` 组件的 `qt6`：此应用基于 Qt
|
||||||
|
- `libexiv2`：用以获取和显示更多的图像元信息（可选，推荐）
|
||||||
|
|
||||||
|
然后我们就可以使用任何常规的 C++ 编译器如 g++ 或 MSVC 来进行构建了
|
||||||
|
|
||||||
|
构建过程就是常规的 CMake 应用构建过程:
|
||||||
|
|
||||||
|
``` bash
|
||||||
|
$ mkdir build && cd build
|
||||||
|
$ cmake ..
|
||||||
|
$ cmake --build . # 如果你使用 Makefile 作为 CMake 生成器，也可以直接简单的使用 `make`
|
||||||
|
```
|
||||||
|
|
||||||
|
完毕后，一个名为 `scwpic` 的可执行程序即会被生成以供使用。您也可以选择通过使用 CMake 生成的 `install` 目标继续将其安装到您的设备上。构建步骤完毕后，您也可以使用 `cpack` 来对应用程序进行打包。
|
||||||
|
|
||||||
|
当 `exiv2` 在构建时可用时，此项目将尝试使用其进行构建，若您不希望使用 `exiv2`，请传递 `-DEXIV2_METADATA_SUPPORT=OFF` 参数给 `cmake`。此项目在找不到 `exiv2` 时并不会使用 `exiv2`，`EXIV2_METADATA_SUPPORT` 选项可供尽管存在可用的 `exiv2` 但您明确不希望启用其支持时使用。
|
||||||
|
|
||||||
|
此应用的图片格式支持依赖于 Qt 的 imageformats 插件，直接从您所用的发行版获取对应的图像格式插件即可。对于 Windows 用户，您可能需要手动构建和使用图像格式插件。下方给出了进一步的说明。
|
||||||
|
|
||||||
|
在 Windows、Linux 以及 macOS 系统均可构建此应用，其它有移植 Qt 支持的平台也可能可以进行构建。
|
||||||
|
|
||||||
|
## 许可协议
|
||||||
|
|
||||||
|
SarasaCW 照片查看器整体使用 MIT 协议进行发布。项目所随的部分源文件可能具备不同但与之兼容的许可协议。
|
||||||
@@ -1,88 +0,0 @@
|
|||||||
# Sarasas Chip Workshop 照片查看器
|
|
||||||
|
|
||||||
简单轻量的、具有跨平台支持的、经典样式的 Windows 照片查看器。
|
|
||||||
|
|
||||||
> [!IMPORTANT]
|
|
||||||
> SarasaCW 照片查看器还在重构中。在这条信息被移除之前请不要使用它。
|
|
||||||
|
|
||||||
## 简介
|
|
||||||
|
|
||||||
Sarasas Chip Workshop 照片查看器（简称 SarasaCW 照片查看器）是一个轻量级的图片查看器。支持跨平台。界面风格类似于经典的 Windows 照片查看器。它可以让你快速轻松地浏览 JPEG、PNG、GIF、SVG、PSD、KRA、XCF、TGA、HDR、AVIF 以及其他一些常用的图片格式，且无需改变你长期的 Windows 使用习惯。
|
|
||||||
|
|
||||||
SarasaCW 照片查看器是[菠萝看图](https://github.com/BLumia/pineapple-pictures)的**硬分叉**，该分叉自菠萝看图 1.4.1 版本开始。
|
|
||||||
|
|
||||||
<!--
|
|
||||||
|
|
||||||
简单轻量的跨平台看图工具。
|
|
||||||
|
|
||||||
|CI|构建状态|
|
|
||||||
|---|---|
|
|
||||||
|Windows Build|[](https://github.com/BLumia/pineapple-pictures/actions/workflows/windows.yml)|
|
|
||||||
|macOS Build|[](https://github.com/BLumia/pineapple-pictures/actions/workflows/macos.yml)|
|
|
||||||
|Ubuntu Build|[](https://github.com/BLumia/pineapple-pictures/actions/workflows/ubuntu.yml)|
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## 立即获取!
|
|
||||||
|
|
||||||
### 由原作者维护
|
|
||||||
|
|
||||||
- [GitHub Release 页面](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 商店](https://blumia.itch.io/pineapple-pictures)
|
|
||||||
- [Microsoft Store](https://apps.microsoft.com/store/detail/9MXGX66VVGJP)
|
|
||||||
- Flatpak (于 FlatHub): [net.blumia.pineapple-pictures](https://flathub.org/apps/net.blumia.pineapple-pictures) *([我应当使用 flatpak 版吗？](https://github.com/BLumia/pineapple-pictures/wiki/Container%E2%80%90based-Packaging-Solutions-Support))*
|
|
||||||
|
|
||||||
### 由贡献者/对应发行版的打包人员维护
|
|
||||||
|
|
||||||
[](https://repology.org/project/pineapple-pictures/versions)
|
|
||||||
|
|
||||||
## 参与贡献
|
|
||||||
|
|
||||||
除了参与反馈和代码贡献外，也欢迎各种类型的贡献！
|
|
||||||
|
|
||||||
### 帮助翻译!
|
|
||||||
|
|
||||||
[在 Weblate 上帮助此项目翻译到更多语言!](https://hosted.weblate.org/projects/pineapple-pictures/)
|
|
||||||
|
|
||||||
### 打赏
|
|
||||||
|
|
||||||
[Afdian | 爱发电](https://afdian.com/a/BLumia)
|
|
||||||
|
|
||||||
[](https://ko-fi.com/blumia)
|
|
||||||
|
|
||||||
## 手动构建步骤:
|
|
||||||
|
|
||||||
当前状态，我们需要先确保如下依赖可用:
|
|
||||||
|
|
||||||
- `cmake`: 我们所使用的构建系统
|
|
||||||
- 包含 `qt6-svg` 与 `qt6-tools` 组件的 `qt6`: 此应用基于 Qt
|
|
||||||
- `libexiv2`: 用以获取和显示更多的图像元信息（可选，推荐）
|
|
||||||
|
|
||||||
然后我们就可以使用任何常规的 c++ 编译器如 g++ 或 msvc 来进行构建了
|
|
||||||
|
|
||||||
构建过程就是常规的 CMake 应用构建过程:
|
|
||||||
|
|
||||||
``` bash
|
|
||||||
$ mkdir build && cd build
|
|
||||||
$ cmake ..
|
|
||||||
$ cmake --build . # 如果你使用 Makefile 作为 CMake 生成器，也可以直接简单的使用 `make`
|
|
||||||
```
|
|
||||||
|
|
||||||
完毕后，一个名为 `ppic` 的可执行程序即会被生成以供使用。您也可以选择通过使用 CMake 生成的 `install` 目标继续将其安装到您的设备上（假设您使用 Makefile，即可执行 `make install` 来进行安装）。构建步骤完毕后，您也可以使用 `cpack` 来对应用程序进行打包。
|
|
||||||
|
|
||||||
当 `exiv2` 在构建时可用时，此项目将尝试使用其进行构建，若您不希望使用 `exiv2`，请传递 `-DEXIV2_METADATA_SUPPORT=OFF` 参数给 `cmake`。此项目在找不到 `exiv2` 时并不会使用 `exiv2`，`EXIV2_METADATA_SUPPORT` 选项可供尽管存在可用的 `exiv2` 但您明确不希望启用其支持时使用。
|
|
||||||
|
|
||||||
此应用的图片格式支持依赖于 Qt 的 imageformats 插件，直接从您所用的发行版获取对应的图像格式插件即可。对于 Windows 用户，您可能需要手动构建和使用图像格式插件。下方给出了进一步的说明。
|
|
||||||
|
|
||||||
在 Windows、Linux 以及 macOS 系统均可构建此应用，其它有移植 Qt 支持的平台也可能可以进行构建。若要了解一些平台相关的构建指引，请参阅[相关的 Wiki 页面](https://github.com/BLumia/pineapple-pictures/wiki/Platform-Specific-Build-Instructions)。
|
|
||||||
|
|
||||||
> [!NOTE]
|
|
||||||
> 尽管存在一个可用于 QMake 构建的 `pineapple-pictures.pro` 文件，但其仅供简单测试所用且其并不包含 `exiv2` 支持。使用 QMake 构建此项目是 **不受支持** 的，请尽可能考虑使用 CMake。
|
|
||||||
|
|
||||||
## 许可协议
|
|
||||||
|
|
||||||
菠萝看图整体使用 MIT 协议进行发布。项目所随的部分源文件可能具备不同但与之兼容的许可协议。
|
|
||||||
|
|
||||||
-->
|
|
||||||
Reference in New Issue
Block a user