Skip to content

Commit

Permalink
docs: update site https://flipped.xmuli.tech
Browse files Browse the repository at this point in the history
  • Loading branch information
XMuli committed May 30, 2024
1 parent 4a3ec4f commit 46e5c73
Show file tree
Hide file tree
Showing 57 changed files with 2,265 additions and 0 deletions.
5 changes: 5 additions & 0 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
_site
.sass-cache
Gemfile.lock
*.gem
.jekyll-cache
11 changes: 11 additions & 0 deletions docs/.rubocop.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
inherit_gem:
rubocop-github:
- config/default.yml

AllCops:
Exclude:
- _site/**/*
- vendor/**/*

Layout/LineLength:
Enabled: false
6 changes: 6 additions & 0 deletions docs/.travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
language: ruby
cache: bundler
rvm: 2.6

install: script/bootstrap
script: script/cibuild
1 change: 1 addition & 0 deletions docs/CNAME
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
flipped.xmuli.tech
5 changes: 5 additions & 0 deletions docs/Gemfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# frozen_string_literal: true

source "https://rubygems.org"

gemspec
205 changes: 205 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,205 @@
<div align="center">
<p>
<h1>
<a href="https://github.com/XMuli/FLIPPED">
<img src="snapshot/Flipped.svg" alt="FLIPPED" />
</a>
<br/>
FLIPPED
</h1>
<br/>
<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/FILPPED/releases">
<img src="https://img.shields.io/github/languages/code-size/XMuli/FILPPED" alt="code-size" />
</a>
<a href="https://github.com/XMuli/FILPPED/releases">
<img src="https://img.shields.io/github/downloads/XMuli/FILPPED/total" alt="Total Downloads" />
</a>
<a href="https://github.com/XMuli/FILPPED">
<img src="https://img.shields.io/github/release/XMuli/FILPPED.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

- 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

- [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)

<br>

### Snapshoot

- **MacOS**

<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/202303121524707.jpg" width="100%"/>

- **Windows**

<img src="https://fastly.jsdelivr.net/gh/XMuli/xmuliPic@pic/2022/202303121616530.jpg" width="100%"/>

<img src="https://fastly.jsdelivr.net/gh/XMuli/xmuliPic@pic/2022/202303121524281.jpg" width="100%"/>

- **Linux**

<img src="https://fastly.jsdelivr.net/gh/XMuli/xmuliPic@pic/2022/202303121447431.jpg" width="100%"/>

<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%"/>

<br>

## Keyboard shortcuts

| Keys | Description | Mode |
| ------------------------------------------------------------ | ------------------------------- | ------ |
| <kbd>←</kbd>, <kbd>↓</kbd>, <kbd>↑</kbd>, <kbd>→</kbd> ( <kbd>A</kbd>, <kbd>S</kbd>, <kbd>W</kbd>, <kbd>D</kbd> ) | Move selection 1px | Local |
| <kbd>Ctrl</kbd> + <kbd>←</kbd>, <kbd>↓</kbd>, <kbd>↑</kbd>, <kbd>→</kbd> | Extended selection 1 px | Local |
| <kbd>Alt</kbd> + <kbd>←</kbd>, <kbd>↓</kbd>, <kbd>↑</kbd>, <kbd>→</kbd> | Shrink selection 1 px | Local |
| <kbd>Shift</kbd> + <kbd>←</kbd>, <kbd>↓</kbd>, <kbd>↑</kbd>, <kbd>→</kbd> | Move selection 10 px | Local |
| <kbd>Shift</kbd> + <kbd>Ctrl</kbd> + <kbd>←</kbd>, <kbd>↓</kbd>, <kbd>↑</kbd>, <kbd>→</kbd> | Extended selection 10 px | Local |
| <kbd>Shift</kbd> + <kbd>Alt</kbd> + <kbd>←</kbd>, <kbd>↓</kbd>, <kbd>↑</kbd>, <kbd>→</kbd> | Shrink selection 10 px | Local |
| <kbd>Shift</kbd> + <kbd>F4</kbd> | Quick Save Image | Local |
| <kbd>Esc</kbd> | Quit | Local |
| | | |
| <kbd>F6</kbd> | Window activation capture scree | Global |
| <kbd>F7</kbd> | Time-lapse screen capture | Global |
| <kbd>F8</kbd> | Full screen capture screen | Global |

<br>

## Compilation

### Dependencies

- Qt >= 5.15.2
- CMake >= 3.16
- MSVC >= 2019 | MinGW >= 8.1.0 | GCC >= 9.4 | Clang >= 12.0

​ NOTE: This is a successfully compiled dependency version, lower versions have not been tested.

<br>

### Windows

- **Kit Tools:** Windows 10 & Qt 5.15.2 & CMake 3.24.1 & MSVC 2019 ( or MinGW 8.1.0)

- **Compile Step:**

```bash
# ******************** MSVC 2019 ********************
#『Step1』
# x86:
# 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"

# 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"

#『Step2』
Visual Studio 2019 open `Flipped.sln`

#『Step3』
windeployqt bin/Flipped.exe --no-translations

# ******************** MinGW 8.1.0 ********************
QtCreator opens the `CMakeLists.txt` file in the root directory of the source code
```

<br>

### MacOS / Linux

- **Kit Tools:**

- **MacOS:** MacOS 10.15 & Qt 5.15.2 & CMake 3.24 & Clang 12.0
- **Linux:** Ubuntu 20.04 & Qt 5.15.2 & CMake 3.24 & GCC 9.4

- **Compile Step:**

```bash
git clone --recursive https://github.com/XMuli/Flipped.git
cd Flipped
mkdir build & cd build
cmake ..
make -j16
```

<br>

## Author

| [![alt text](https://img.shields.io/badge/GitHub-XMuli-brightgreen)](https://github.com/XMuli) : View my homepage | [![alt text](https://img.shields.io/badge/Blog-%E5%81%95%E8%87%A7%E7%9A%84%E5%B0%8F%E7%AB%99-ff69b4)](https://ifmet.cn/) : Curious about my nest |
| :----------------------------------------------------------- | :----------------------------------------------------------- |
| [![alt text](https://img.shields.io/badge/QQ-XMuli-brightgreen)](https://sighttp.qq.com/authd?IDKEY=31f3ef7312b39e2c8dc822ae2f4c3b3118e1a6f31cc83373) : Chat with me directly~ | [![alt text](https://img.shields.io/badge/Blog-国内镜像-ff69b4)](https://blog.csdn.net/qq_33154343) :Views 100W+ |

<br>

## Contributors

If it helps you, or find it useful, <font color=#FE7207 size=4 face="幼圆">you can click on the item's <font color=#D0087E size=4 face="幼圆">**⭐Star** **🍴 Fork** </font> of the two icons, conveniently lift the hand between, said a point of praise the hand,</font> There is a fragrance in your hand;The next best thing is to buy me a cold Coke.

<br>

<details>
<summary> <b>Of course you can also give a cold Coke [Donate/Reward ← Click 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>
<pre><img src="https://fastly.jsdelivr.net/gh/XMuli/xmuliPic@pic/2022/202302282339037.png" width="80%"/></pre>
</details>

<br>

## Feedback & How to contribute

Feedback & How to contribute

You are very welcome to join us! You can [open an issue](https://github.com/XMuli/FILPPED/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/FILPPED/releases); </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>

<br>

## Series Address

[QtExamples](https://github.com/XMuli/QtExamples) Welcome `star` ⭐ and `fork` 🍴 to this series of `C++ / QT / DTK` studies, with a table of contents for learning from the beginning to the end
5 changes: 5 additions & 0 deletions docs/_config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
title: FLIPPED
description: Simple and beautiful screenshot software for Windows, MacOS and Linux.
show_downloads: true
google_analytics:
theme: jekyll-theme-architect
10 changes: 10 additions & 0 deletions docs/_includes/head-custom-google-analytics.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{% if site.google_analytics %}
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', '{{ site.google_analytics }}', 'auto');
ga('send', 'pageview');
</script>
{% endif %}
9 changes: 9 additions & 0 deletions docs/_includes/head-custom.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<!-- start custom head snippets, customize with your own _includes/head-custom.html file -->

<!-- Setup Google Analytics -->
{% include head-custom-google-analytics.html %}

<!-- You can set your favicon here -->
<!-- link rel="shortcut icon" type="image/x-icon" href="{{ '/favicon.ico' | relative_url }}" -->

<!-- end custom head snippets -->
63 changes: 63 additions & 0 deletions docs/_layouts/default.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
<!DOCTYPE html>
<html lang="{{ site.lang | default: "en-US" }}">
<head>
<meta charset='utf-8'>
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1">
<link rel="stylesheet" href="{{ '/assets/css/style.css?v=' | append: site.github.build_revision | relative_url }}" media="screen" type="text/css">
<link rel="stylesheet" href="{{ '/assets/css/print.css' | relative_url }}" media="print" type="text/css">

<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script>
<![endif]-->

{% seo %}

{% include head-custom.html %}
</head>

<body>
<header>
<div class="inner">
<a href="{{ '/' | absolute_url }}">
<h1>{{ site.title | default: site.github.repository_name }}</h1>
</a>
<h2>{{ site.description | default: site.github.project_tagline }}</h2>
{% if site.github.is_project_page %}
<a href="{{ site.github.repository_url }}" class="button"><small>View project on</small> GitHub</a>
{% endif %}
{% if site.github.is_user_page %}
<a href="https://github.com/XMuli/FlippedPages" class="button"><small>Follow me on</small> GitHub</a>
{% endif %}
</div>
</header>

<div id="content-wrapper">
<div class="inner clearfix">
<section id="main-content">
{{ content }}
</section>

<aside id="sidebar">
{% if site.show_downloads %}
<a href="https://github.com/XMuli/FlippedPages/releases" class="button">
<small>Download</small>
.zip file
</a>
<a href="https://github.com/XMuli/FlippedPages/wiki" class="button">
<small>Download</small>
.tar.gz file
</a>
{% endif %}

{% if site.github.is_project_page %}
<p class="repo-owner"><a href="{{ site.github.repository_url }}">{{ site.github.repository_name }}</a> is maintained by <a href="{{ site.github.owner_url }}">{{ site.github.owner_name }}</a>.</p>
{% endif %}

<p>This page was generated by <a href="https://pages.github.com">GitHub Pages</a>.</p>
</aside>
</div>
</div>

</body>
</html>
4 changes: 4 additions & 0 deletions docs/_sass/architect.scss
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
// Placeholder file. If your site uses
// @import "{{ site.theme }}";
// Then using this theme with jekyll-remote-theme will work fine.
@import "jekyll-theme-architect";
Loading

0 comments on commit 46e5c73

Please sign in to comment.