Skip to content

Commit

Permalink
docs: update v1.3.0
Browse files Browse the repository at this point in the history
  • Loading branch information
XMuli committed Dec 27, 2023
1 parent 43d4519 commit bcb0b8f
Show file tree
Hide file tree
Showing 11 changed files with 266 additions and 31 deletions.
69 changes: 69 additions & 0 deletions docs/docs/licenses/License.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
## Sunny- Licensing and Disclaimer

### Copyright (c) 2023~2024 https://sunny.xmuli.tech

Unless otherwise stated, all documents and software included in the Sunny installation package are the property of https://github.com/XMuli.

This software is provided as-is, without any express or implied warranties. In no event shall the author be liable for any damages arising from the use of this software.

### Scope of Use

1. This software is allowed for personal use free of charge.
2. This software is allowed for commercial use by teams or companies, but prior authorization through email contact is required.
3. For any custom features or other business collaborations, feel free to reach out to us via email.

### Software Distribution

Under the following conditions, anyone is allowed to redistribute this software:

1. All texts, logo images, website content, and styles must be distributed with all existing copyright notices and this list of conditions, without any modifications.
2. All binary redistributions must retain all instances of the above copyright notice and the website address:
- Website address (e.g., in an "About" box).
- Modifications, cracking, or any alterations to the binary form are prohibited, including any tampering with information prompts inside.
- Misrepresenting the origin of this software is prohibited; you may not claim that you wrote the original software.
- If you use this software to publish a product, please acknowledge it in the product documentation.
- If you use this software to publish a product or work, acknowledging it in the product documentation is appreciated but not required.

3. For any modifications made with individual authorization, modified versions in text documents, image resources, and binary form must be clearly marked as such and may not be misrepresented as the original software.

## Disclaimer

Welcome to Sunny! Before using the Sunny client, please carefully read and understand the following disclaimer to fully comprehend your rights and responsibilities. By using the Sunny client, you accept the following disclaimer and agree to comply with its terms and conditions. If you do not agree with the content below, please stop using this software.

1. **Service Provision**

The Sunny client primarily utilizes relevant system APIs to capture screenshots and perform related operations on the system. All screenshot-related features are provided for user reference and entertainment purposes only. Users are advised to back up important data independently. Users assume full responsibility for any results generated using this software, and we make no express or implied warranties about the accuracy, completeness, or practicality of the results.

2. **Data Sources**

All data originates from Sunny and the user's own actions.

3. **Personal Privacy**

We highly value your personal privacy and will take reasonable measures to protect your personal information. This software operates without the need for an internet connection, which means that all data is exclusively stored locally on your device. Therefore, there is no data being uploaded or analyzed. Please feel free to use it without any concerns in this regard.. For specific policies regarding personal privacy, please refer to our privacy policy.

4. **Liability Terms**

- Users are solely responsible for any results generated using the Sunny client. We are not liable for any losses or damages arising from the use of this software.
- We are not liable for any interruptions, delays, or errors caused by force majeure, accidents, or failures of third-party service providers.
- We are not liable for any difficulties or errors caused by users' own devices or network environments.

5. **Intellectual Property**

All contents of the Sunny client, including but not limited to text, images, logos, icons, software, audio, and video, are protected by intellectual property laws. Without authorization, it is forbidden to use any content of the Sunny client for commercial purposes, distribution, or replication.

6. **Usage Restrictions**

The Sunny client is for personal use only and should not be used for commercial purposes. Users under the age of 18 must use this software under the supervision of their parents or guardians.

7. **Other Terms**

- We reserve the right to change and modify this disclaimer at any time without prior notice.
- In case of any disputes arising from the use of the Sunny client, the local laws shall apply.

Please read and understand the above disclaimer carefully before using the Sunny client. If you have any questions or opinions about the disclaimer, please contact us:

XMuli
[email protected]

Thank you for choosing the Sunny client; we will continue to provide quality service and respect your rights.
1 change: 1 addition & 0 deletions docs/docs/licenses/Other.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Other
19 changes: 19 additions & 0 deletions docs/docs/licenses/PrivacyAndDataProtection.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
## Sunny- Privacy and Data Protection

When you use the image translation or text extraction (OCR) from images feature, the image will be uploaded to a third-party server to obtain results through their API. By using this functionality, you are deemed to comply with the relevant licensing agreements. This feature requires an internet connection.

All other functionalities operate locally without the need for any network permissions. All data is stored exclusively on your local machine.

Privacy policies of API providers:

- YouDao API: https://fanyi.youdao.com/openapi
- Baidu API: https://ai.baidu.com/ai-doc/REFERENCE/kk3dwjg7d



Please read and understand the above privacy policy carefully before using the Sunny client. We place a high value on your privacy and continuously strive to improve our privacy and data protection measures to ensure the security of your personal information. If you have any questions or comments regarding the privacy policy or data processing, please contact us at:

XMuli
[email protected]

Thank you for choosing Sunny. We will continue to provide high-quality services and protect your personal information.
19 changes: 19 additions & 0 deletions docs/docs/licenses/tripartite/README.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
Easylogging++
https://github.com/abumq/easyloggingpp
MIT license
C++ logging library

json
https://github.com/nlohmann/json
MIT license
JSON for Modern C++

QHotkey
https://github.com/Skycoder42/QHotkey
BSD-3-Clause license
A global shortcut/hotkey for Desktop Qt-Applications

Qt-AES
https://github.com/bricke/Qt-AES
Unlicense license
Native Qt AES encryption class
27 changes: 27 additions & 0 deletions docs/docs/licenses/tripartite/Skycoder42_QHotkey_LICENSE.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
Copyright (c) 2016, Felix Barz
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.

* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.

* Neither the name of QHotkey nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
20 changes: 20 additions & 0 deletions docs/docs/licenses/tripartite/abumq_easylogging++_MIT_LICENSE.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
The MIT License (MIT)

Copyright (c) 2012-present @abumq (Majid Q.)

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
24 changes: 24 additions & 0 deletions docs/docs/licenses/tripartite/bricke_Qt-AES_Unlicense_LICENSE.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
This is free and unencumbered software released into the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or
distribute this software, either in source code form or as a compiled
binary, for any purpose, commercial or non-commercial, and by any
means.

In jurisdictions that recognize copyright laws, the author or authors
of this software dedicate any and all copyright interest in the
software to the public domain. We make this dedication for the benefit
of the public at large and to the detriment of our heirs and
successors. We intend this dedication to be an overt act of
relinquishment in perpetuity of all present and future rights to this
software under copyright law.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

For more information, please refer to <http://unlicense.org>
21 changes: 21 additions & 0 deletions docs/docs/licenses/tripartite/nlohmann_json_MIT_LICENSE.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2013-2022 Niels Lohmann

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
36 changes: 25 additions & 11 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,14 +34,15 @@ Sunny is a simple and beautiful screenshot software tool for Windows, MacOS and

### Site

| Name | URL |
| ---------- | ------------------------------------------------------------ |
| **Site** | [https://sunny.xmuli.tech](https://sunny.xmuli.tech) |
| **GitHub** | [https://github.com/XMuli/SunnyPages](https://github.com/XMuli/SunnyPages) |
| Gitee | [https://gitee.com/XMuli/SunnyPages](https://gitee.com/XMuli/SunnyPages) |
| | |
| Down | [releases](https://github.com/XMuli/SunnyPages/releases) |
| Feedback | [Issues](https://github.com/XMuli/SunnyPages/issues) |
| Name | URL |
| ----------- | ------------------------------------------------------------ |
| **Site** | [https://sunny.xmuli.tech](https://sunny.xmuli.tech) |
| **GitHub** | [https://github.com/XMuli/SunnyPages](https://github.com/XMuli/SunnyPages) |
| Gitee | [https://gitee.com/XMuli/SunnyPages](https://gitee.com/XMuli/SunnyPages) |
| | |
| Down | [releases](https://github.com/XMuli/SunnyPages/releases), UOS / Deepin Store, Spark Store |
| Feedback | [Issues](https://github.com/XMuli/SunnyPages/issues) |
| WeChat / QQ | 252311126 |

Feedback Bugs, Suggestions or Ideas; any help to improve, you can join the exchange group: ![alt text](https://img.shields.io/badge/QQ_Groups-418103279-brightgreen)

Expand All @@ -60,17 +61,18 @@ Feedback Bugs, Suggestions or Ideas; any help to improve, you can join the excha

### Windows

​ <img src="snapshot/snapshoot-windows-05.png" width="45%"/> <img src="snapshot/snapshoot-windows-06.png" width="45%">
​ <img src="https://fastly.jsdelivr.net/gh/XMuli/xmuliPic@pic/2023/202312272301064.png" width="45%"/> <img src="https://fastly.jsdelivr.net/gh/XMuli/xmuliPic@pic/2023/202312272303776.png" width="45%"/>

### Linux

- **Ubuntu 22.04**

<img src="snapshot/snapshoot-ubuntu-01.png" width="45%"/> <img src="snapshot/snapshoot-ubuntu-04.png" width="45%"/>
<img src="https://fastly.jsdelivr.net/gh/XMuli/xmuliPic@pic/2023/202312272304154.png" width="45%"/> <img src="https://fastly.jsdelivr.net/gh/XMuli/xmuliPic@pic/2023/202312272305584.png" width="45%"/>

- **Deepin V20.9 / UOS**

<img src="snapshot/snapshoot-Deepin-01.jpg" width="45%"/> <img src="snapshot/snapshoot-Deepin-02.jpg" width="45%"/>
<img src="https://fastly.jsdelivr.net/gh/XMuli/xmuliPic@pic/2023/202312272305050.jpg" width="45%"/> <img src="https://fastly.jsdelivr.net/gh/XMuli/xmuliPic@pic/2023/202312272305129.jpg" width="45%"/>



## Features
Expand Down Expand Up @@ -106,6 +108,18 @@ Feedback Bugs, Suggestions or Ideas; any help to improve, you can join the excha

<br>

## App Store Down

- **Deepin / UOS Store:**

<img src="https://fastly.jsdelivr.net/gh/XMuli/xmuliPic@pic/2023/202312272306936.png" width="80%"/>

**Spark Store Store:**

<img src="https://fastly.jsdelivr.net/gh/XMuli/xmuliPic@pic/2023/202312272307984.png" width="80%"/>

<br>

## Contributors

If it helps you, or find it useful, you can click on the item's**⭐Star** **🍴 Fork**  of the two icons, conveniently lift the hand between, said a point of praise the hand, There is a fragrance in your hand;The next best thing is to buy me a cold Coke.
Expand Down
61 changes: 41 additions & 20 deletions docs/index.zh_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@

### Describe

Sunny (桑尼) 截图是一款简洁且漂亮的截图的软件工具,支持 Windows,MacOS,Linux 平台。
Sunny 截图是一款简洁且漂亮的截图的软件工具,支持 Windows,MacOS,Linux 平台。



Expand All @@ -41,8 +41,9 @@ Sunny (桑尼) 截图是一款简洁且漂亮的截图的软件工具,支持 W
| **GitHub** | [https://github.com/XMuli/SunnyPages](https://github.com/XMuli/SunnyPages) |
| Gitee | [https://gitee.com/XMuli/SunnyPages](https://gitee.com/XMuli/SunnyPages) |
| | |
| Down | [releases](https://github.com/XMuli/SunnyPages/releases) |
| Down | [releases](https://github.com/XMuli/SunnyPages/releases), UOS / Deepin Store, Spark Store |
| Feedback | [Issues](https://github.com/XMuli/SunnyPages/issues) |
| 微信 / QQ | 252311126 |

反馈 Bug, 提出建议或者想法;任何帮助改进,可以加入交流群:![alt text](https://img.shields.io/badge/QQ_Groups-418103279-brightgreen)

Expand All @@ -58,19 +59,21 @@ Sunny (桑尼) 截图是一款简洁且漂亮的截图的软件工具,支持 W

## Snapshoot

### Windows
- ### Windows

​ <img src="snapshot/snapshoot-windows-05.png" width="45%"/> <img src="snapshot/snapshoot-windows-06.png" width="45%">

### Linux

- **Ubuntu 22.04**

<img src="snapshot/snapshoot-ubuntu-01.png" width="45%"/> <img src="snapshot/snapshoot-ubuntu-04.png" width="45%"/>

- **Deepin V20.9 / UOS**

<img src="snapshot/snapshoot-Deepin-01.jpg" width="45%"/> <img src="snapshot/snapshoot-Deepin-02.jpg" width="45%"/>
​ <img src="https://fastly.jsdelivr.net/gh/XMuli/xmuliPic@pic/2023/202312272301064.png" width="45%"/> <img src="https://fastly.jsdelivr.net/gh/XMuli/xmuliPic@pic/2023/202312272303776.png" width="45%"/>

### Linux

- **Ubuntu 22.04**

<img src="https://fastly.jsdelivr.net/gh/XMuli/xmuliPic@pic/2023/202312272304154.png" width="45%"/> <img src="https://fastly.jsdelivr.net/gh/XMuli/xmuliPic@pic/2023/202312272305584.png" width="45%"/>

- **Deepin V20.9 / UOS**

<img src="https://fastly.jsdelivr.net/gh/XMuli/xmuliPic@pic/2023/202312272305050.jpg" width="45%"/> <img src="https://fastly.jsdelivr.net/gh/XMuli/xmuliPic@pic/2023/202312272305129.jpg" width="45%"/>




## Features
Expand Down Expand Up @@ -106,20 +109,38 @@ Sunny (桑尼) 截图是一款简洁且漂亮的截图的软件工具,支持 W

<br>

## Contributors
## App Store Down

If it helps you, or find it useful, you can click on the item's**⭐Star** **🍴 Fork**  of the two icons, conveniently lift the hand between, said a point of praise the hand, There is a fragrance in your hand;The next best thing is to buy me a cold Coke.
- **Deepin / UOS Store:**

<img src="https://fastly.jsdelivr.net/gh/XMuli/xmuliPic@pic/2023/202312272306936.png" width="80%"/>

**Spark Store Store:**

<img src="https://fastly.jsdelivr.net/gh/XMuli/xmuliPic@pic/2023/202312272307984.png" width="80%"/>

<br>

## 贡献

<details>
<summary> <b>Of course you can also give a cold Coke [Donate/RewardClick to expand QR code]</b></summary>
<p> - If you have something to learn from the project, you can also invite me to share a glass of Fat House Ice and Coke. - </p>
<summary> <b>"当然,你也可以送我一听冰凉的可乐 [捐赠/打赏点击展开二维码]"</b></summary>
<p> 如果对您有帮助,或者觉得有用,**您可以点击该仓库的⭐ Star 🍴 Fork 两个图标,方便抬手之间,说点赞的手,** 手留余香;其次可以我喝一杯冰的快乐水 - </p>
<pre><img src="https://fastly.jsdelivr.net/gh/XMuli/xmuliPic@pic/2022/202302282339037.png" width="80%"/></pre>
</details>

<br>

## Development Experience Article
## 作者

[email protected] | https://sunny.xmuli.tech

## 更多

[QtExamples](https://github.com/XMuli/QtExamples) Welcome `star` ⭐ and `fork` 🍴 to this series of `C++ / QT / DTK` studies, Here you can learn the experience of how to write one of this software by yourself, it's a complete series and **it's free**!
当我想到时,我会把它添加到这里或维基上。



## Development Experience Article

[QtExamples](https://github.com/XMuli/QtExamples) "欢迎 `star` ⭐ 和 `fork` 🍴 这个系列的 `C++ / QT / DTK` 学习,这里你可以学到如何亲自编写这类软件的经验,这是一系列完整的教程,并且**免费**!"
File renamed without changes

0 comments on commit bcb0b8f

Please sign in to comment.