chroe: init docs

SunnyCapturer · Aug 14, 2023 · a8f44ad · a8f44ad
1 parent 57477a2
commit a8f44ad
Show file tree

Hide file tree

Showing 60 changed files with 2,251 additions and 64 deletions.
diff --git a/LICENSE b/LICENSE
@@ -1,21 +1,9 @@
-MIT License
+License
 
-Copyright (c) 2023 XMuli
+Copyright (c) 2022-2023 XMuli
 
-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:
+Individuals can use it permanently for free, and are allowed to distribute the binary program and related documentation, but please mark the original link in a prominent place, such as in the article.
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
+For teams or commercial companies, please contact xmulitech@gmail.com for authorization.
 
-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.
+Of course, special feature customization is also supported, or with developers of the same interest, for life/github/coding cloud linkage
diff --git a/README.md b/README.md
@@ -1,80 +1,85 @@
 <div align="center">
   <p>
       <h1>
-      <a href="https://github.com/XMuli/Flipped">
-          <img src="snapshot/Flipped.svg"  alt="Flipped" />
+      <a href="https://github.com/XMuli/FLIPPED">
+          <img src="snapshot/Flipped.svg"  alt="FLIPPED" />
       </a>
       <br/>
-      Flipped
+      FLIPPED
     </h1>
     <br/>
-    <h4>Simple and beautiful cross-platform screenshot software.</h4>
+    <h4>Simple and beautiful screenshot software tool for Windows, MacOS and Linux</h4>
+    <h4>简洁且漂亮的截图的软件工具，支持 Windows，MacOS，Linux 平台</h4>
+    <h4>簡潔且漂亮的截圖的軟件工具，支持 Windows，MacOS，Linux 平臺</h4>
   </p>
   <p>
-    <a href="https://github.com/XMuli/FlippedPackage/releases">
-      <img src="https://img.shields.io/github/languages/code-size/XMuli/FlippedPackage" alt="code-size" />
+    <a href="https://github.com/XMuli/FLIPPED/releases">
+      <img src="https://img.shields.io/github/languages/code-size/XMuli/FLIPPED" alt="code-size" />
     </a>
-    <a href="https://github.com/XMuli/FlippedPackage/releases">
-      <img src="https://img.shields.io/github/downloads/XMuli/FlippedPackage/total" alt="Total Downloads" />
+    <a href="https://github.com/XMuli/FLIPPED/releases">
+      <img src="https://img.shields.io/github/downloads/XMuli/FLIPPED/total" alt="Total Downloads" />
     </a>
-  <a href="https://github.com/XMuli/FlippedPackage">
-      <img src="https://img.shields.io/github/release/XMuli/FlippedPackage.svg?label=docs" alt="Docs" />
+  <a href="https://github.com/XMuli/FLIPPED">
+      <img src="https://img.shields.io/github/release/XMuli/FLIPPED.svg?label=docs" alt="Docs" />
     </a>
   </p>
   <p align="right"><br><a href="README.md">English</a> | <a href="README.zh_CN.md">简体中文</a></p>
 </div>
 
-[TOC]
 
-<br>
 
-## Features
+[TOC]
 
-- Multi-screen screenshot, time-lapse screenshot, custom screenshot
-- Pinning the picture
-- Intelligent window recognition（Windows & Linux）
-- Draw Rectangle, Ellipse, Arrow, Custom Path, Mosaic, Text, Serial Number
-- Undo, Redo (multi-level), Save, Cancel, Copy
-- Plugin Framework
-- Update ... 
 
-<br>
 
 ## Preview
 
-### Voide
+- **GitHub:** [https://github.com/XMuli/FLIPPED](https://github.com/XMuli/FLIPPED)
+- **Site:**  [https://xmuli.tech/FLIPPED/](https://xmuli.tech/FLIPPED/)
 
-- [P1] [FLIPPED-MACOS operation demonstration](https://www.bilibili.com/video/BV1rX4y1D7EZ?p=1)
-- [P2] [FLIPPED-WINDOWS operation demonstration](https://www.bilibili.com/video/BV1rX4y1D7EZ?p=2)
-- [P3] [FLIPPED-LINUX (ubuntu 20.04) operation demonstration](https://www.bilibili.com/video/BV1rX4y1D7EZ?p=3)
+### Snapshot
 
-<br>
+- **MACOS:**
 
-### Snapshoot
+  <img src="snapshot/MacOS13_Cover.jpg" width="100%"/>
 
-- **MacOS**
+- **WINDOWS:**
 
-  <img src="https://fastly.jsdelivr.net/gh/XMuli/xmuliPic@pic/2022/202303121457071.jpg" width="100%"/>
+  <img src="snapshot/Windows10_Couer.jpg" width="100%"/>
 
-  <img src="https://fastly.jsdelivr.net/gh/XMuli/xmuliPic@pic/2022/202303121524707.jpg" width="100%"/>
+- **LINUX:**
 
-- **Windows**
+  <img src="snapshot/Ubuntu20.04_Cover.jpg" width="100%"/>
 
-  <img src="https://fastly.jsdelivr.net/gh/XMuli/xmuliPic@pic/2022/202303121616530.jpg" width="100%"/>
+- **Screenshots  & Editor:**
 
-  <img src="https://fastly.jsdelivr.net/gh/XMuli/xmuliPic@pic/2022/202303121524281.jpg" width="100%"/>
+  <img src="https://fastly.jsdelivr.net/gh/XMuli/xmuliPic@pic/2022/202303121457071.jpg" width="100%"/><img src="https://fastly.jsdelivr.net/gh/XMuli/xmuliPic@pic/2022/202303121616530.jpg" width="100%"/>
 
-- **Linux**
+- **Other:**
 
-  <img src="https://fastly.jsdelivr.net/gh/XMuli/xmuliPic@pic/2022/202303121447431.jpg" width="100%"/>
+<font color=#D0087E size=4 face="幼圆"> **Other:** More snapshoot effects can be → [here](./snapshot) preview </font>
 
-<br>
 
-<font color=#D0087E size=4 face="幼圆"> **Other:** More snapshoot effects can be → [here](./snapshot) preview </font>
 
-<img src="https://fastly.jsdelivr.net/gh/XMuli/xmuliPic@pic/2022/202303121515818.jpg" width="30%"/> <img src="https://fastly.jsdelivr.net/gh/XMuli/xmuliPic@pic/2022/202303121522838.jpg" width="30%"/>
+### Voide
+
+- [P1] [FLIPPED-MACOS operation demonstration](https://www.bilibili.com/video/BV1rX4y1D7EZ?p=1)
+- [P2] [FLIPPED-WINDOWS operation demonstration](https://www.bilibili.com/video/BV1rX4y1D7EZ?p=2)
+- [P3] [FLIPPED-LINUX (ubuntu 20.04) operation demonstration](https://www.bilibili.com/video/BV1rX4y1D7EZ?p=3)
+
+
+
+## Features
+
+- Multi-screen screenshot, time-lapse screenshot, custom screenshot
+- Pinning the picture
+- Intelligent window recognition（Windows & Linux）
+- Draw Rectangle, Ellipse, Arrow, Custom Path, Mosaic, Text, Serial Number
+- Undo, Redo (multi-level), Save, Cancel, Copy
+- Plugin Framework
+- Update ... 
+
 
-<br>
 
 ## Keyboard shortcuts
 
@@ -120,19 +125,19 @@
   # After adding "C:\Qt\5.15.2\msvc2019\bin" to the path, execute echo %PATH% in the terminal to make it take effect immediately.
   "C:\Program Files (x86)\Microsoft Visual Studio\2019\Professional\VC\Auxiliary\Build\vcvarsall.bat" x86
   cmake -G "Visual Studio 16 2019" -A Win32 ..
-  devenv Flipped.sln /Build "Release|Win32"
+  devenv FLIPPED.sln /Build "Release|Win32"
 
   # x64:
   # After adding "C:\Qt\5.15.2\msvc2019_64\bin" to the path, execute echo %PATH% in the terminal to make it take effect immediately.
   "C:\Program Files (x86)\Microsoft Visual Studio\2019\Professional\VC\Auxiliary\Build\vcvarsall.bat" x64
   cmake -G "Visual Studio 16 2019" -A x64 ..
-  devenv Flipped.sln /Build "Release|x64"
+  devenv FLIPPED.sln /Build "Release|x64"
 
   #『Step2』
-  Visual Studio 2019 open `Flipped.sln`
+  Visual Studio 2019 open `FLIPPED.sln`
 
   #『Step3』
-  windeployqt  bin/Flipped.exe --no-translations
+  windeployqt  bin/FLIPPED.exe --no-translations
 
   # ******************** MinGW 8.1.0 ********************
   QtCreator opens the `CMakeLists.txt` file in the root directory of the source code
@@ -150,8 +155,8 @@
 - **Compile Step:**
 
   ```bash
-  git clone --recursive https://github.com/XMuli/Flipped.git
-  cd Flipped
+  git clone --recursive https://github.com/XMuli/FLIPPED.git
+  cd FLIPPED
   mkdir build & cd build
   cmake ..
   make -j16
@@ -185,13 +190,13 @@ If it helps you, or find it useful, <font color=#FE7207  size=4 face="幼圆">yo
 
 Feedback & How to contribute
 
-You are very welcome to join us! You can [open an issue](https://github.com/XMuli/FlippedPackage/issues) ; for any bug, suggestion, feature idea, or to help improve this software. Or help improve the project by submitting a Pull Request.
+You are very welcome to join us! You can [open an issue](https://github.com/XMuli/FLIPPED/issues) ; for any bug, suggestion, feature idea, or to help improve this software. Or help improve the project by submitting a Pull Request.
 
 <br>
 
 ## Package Download
 
-<font color=#D0087E> → Offline Installer Download [Releases](https://github.com/XMuli/FlippedPackage/releases); </font>
+<font color=#D0087E> → Offline Installer Download [xmuli.tech/FLIPPED/](https://xmuli.tech/FLIPPED/); </font>
 
 <font color=#D0087E>→ **Feedback BUG/SUGGEST, user community, etc., and the latest version of the installer get** → [![alt text](https://img.shields.io/badge/QQ_Groups-418103279-brightgreen)](https://qm.qq.com/cgi-bin/qm/qr?k=jsD03QzMohGZm0TqYAFh3BvKOpCGlTcT&jump_from=webapi&authKey=DMUwiCQ6ta95PoH8JmtZ+Jz9y7Ozg3yinEsxmm92rNXZRVeMPD7NRgjU+dmUI8Xu)  </font>
 

diff --git a/docs/.gitignore b/docs/.gitignore
@@ -0,0 +1,5 @@
+_site
+.sass-cache
+Gemfile.lock
+*.gem
+.jekyll-cache
diff --git a/docs/.rubocop.yml b/docs/.rubocop.yml
@@ -0,0 +1,11 @@
+inherit_gem:
+  rubocop-github:
+    - config/default.yml
+
+AllCops:
+  Exclude:
+    - _site/**/*
+    - vendor/**/*
+
+Layout/LineLength:
+  Enabled: false
diff --git a/docs/.travis.yml b/docs/.travis.yml
@@ -0,0 +1,6 @@
+language: ruby
+cache: bundler
+rvm: 2.6
+
+install: script/bootstrap
+script: script/cibuild
diff --git a/docs/CNAME b/docs/CNAME
diff --git a/docs/Gemfile b/docs/Gemfile
@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec