Skip to content

Commit

Permalink
add verify information
Browse files Browse the repository at this point in the history
  • Loading branch information
cocomeow committed Dec 7, 2021
1 parent 3ec50bf commit 4418ccd
Show file tree
Hide file tree
Showing 9 changed files with 101 additions and 47 deletions.
2 changes: 1 addition & 1 deletion Contributing.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Contributing

If you're interested in contributing to this project, please open a pull request on our GitHub repository, or send your contact information, such as your telegram account, encrypted with [our GPG Key: 0x6CA67F8C2B1977002086CA96E3CC8F9C451BD83E](https://keys.openpgp.org/vks/v1/by-fingerprint/6CA67F8C2B1977002086CA96E3CC8F9C451BD83E), to the [mailbox](mailto:[email protected]).
If you're interested in contributing to this project, please open a pull request on our GitHub repository, or send your contact information, such as your telegram account, encrypted with [our GPG Key: 0x9B1380D7B700BA9DFAAED4849EEEED2D1566C61B](https://keys.openpgp.org/vks/v1/by-fingerprint/9B1380D7B700BA9DFAAED4849EEEED2D1566C61B), to the [mailbox](mailto:[email protected]).

Also, note that this project is open-source and licensed under [GPL-3.0](https://github.com/ArkToria/ACross/blob/master/LICENSE).

Expand Down
71 changes: 49 additions & 22 deletions Installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,10 @@
## Pre-built Package

### Releases

- https://github.com/arktoria/across/releases

### Git Version
### Git Version

- [Arch Linux](https://github.com/ArkToria/ACross/actions/workflows/arch-build.yaml) | <span id="across-git-archlinux"></span>

Expand All @@ -15,31 +16,55 @@

- [Windows x86_64 - MSYS2](https://github.com/ArkToria/ACross/actions/workflows/msys2-mingw64-build.yaml) | <span id="across-git-mingw-w64"></span>

### Verify The Package

#### Download and install

- Windows: [Gpg4win](https://gpg4win.org/download.html)
- Linux: Install `gnupg` from system package manager
- More: https://gnupg.org/download/

#### Verify from CLI:

```bash
$ gpg --keyserver keys.openpgp.org --recv-keys 9B1380D7B700BA9DFAAED4849EEEED2D1566C61B

$ gpg --verify <across_release_package>.sig
```

#### Verify from GUI:

![search from gui](/Installation/search_from_gui.png)

![verify from gui](/Installation/verify_from_gui.png)

## Build From Source

### Dependencies

- Runtime requirements:
- qt6-base
- qt6-svg
- qt6-quickcontrols2
- qt6-translations
- qt6-tools
- qt6-imageformats
- qt6-5compat
- [curl](https://github.com/curl/curl)
- [fmt](https://github.com/fmtlib/fmt) `>=8.0.0`
- [spdlog](https://github.com/gabime/spdlog) `>=1.9.0`
- [grpc](https://github.com/grpc/grpc)
- [protobuf](https://github.com/protocolbuffers/protobuf)
- [nlohmann-json](https://github.com/nlohmann/json)
- [zxing-cpp](https://github.com/nu-book/zxing-cpp) `>=1.2.0`

- qt6-base
- qt6-svg
- qt6-quickcontrols2
- qt6-translations
- qt6-tools
- qt6-imageformats
- qt6-5compat
- [curl](https://github.com/curl/curl)
- [fmt](https://github.com/fmtlib/fmt) `>=8.0.0`
- [spdlog](https://github.com/gabime/spdlog) `>=1.9.0`
- [grpc](https://github.com/grpc/grpc)
- [protobuf](https://github.com/protocolbuffers/protobuf)
- [nlohmann-json](https://github.com/nlohmann/json)
- [zxing-cpp](https://github.com/nu-book/zxing-cpp) `>=1.2.0`

- Build requirements:
- GCC / Clang / MSVC (Support C++ 20 Standard)
- Ninja (optional)
- Git
- CMake
- GoogleTest
- GCC / Clang / MSVC (Support C++ 20 Standard)
- Ninja (optional)
- Git
- CMake
- GoogleTest

### Linux

Expand All @@ -56,7 +81,7 @@ $ cmake --build .
$ DESTDIR=<installation_directory> cmake --install .
```

> [CPM.cmake](https://github.com/cpm-cmake/CPM.cmake) is a CMake script that adds dependency management capabilities to CMake.
> [CPM.cmake](https://github.com/cpm-cmake/CPM.cmake) is a CMake script that adds dependency management capabilities to CMake.
We use `CPM` as the dependency source manager for C++. In our settings, it will first search the local system package as default. If no dependencies are found, they will be automatically pulled by [FetchContent()](https://cmake.org/cmake/help/latest/module/FetchContent.html) based on the version. However, some basic dependencies like `gcc` and `cmake` still require you to manually build and install.

Expand All @@ -71,6 +96,7 @@ $ cmake .. \
-DFETCH_SINGLE_APPLICATION=OFF \
-GNinja
```

### Windows

#### vcpkg
Expand Down Expand Up @@ -123,6 +149,7 @@ $ cmake --build .
```

#### MSYS2 + MINGW

**Recommended:**

Build the MSYS2 package from [ACross PKGBUILD](https://github.com/ArkToria/ACross/blob/master/pkgbuild/msys2/PKGBUILD) following the official tutorial.
Expand Down Expand Up @@ -175,4 +202,4 @@ $ cmake ../ -GNinja -DCMAKE_BUILD_TYPE=Release
$ cmake --build .
```

The `ENABLE_DEPLOYMENT` option is `ON` by default, this will copy the required resources (including the `*.dll`) to the compiled directory.
The `ENABLE_DEPLOYMENT` option is `ON` by default, this will copy the required resources (including the `*.dll`) to the compiled directory.
Binary file added Installation/search_from_gui.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Installation/verify_from_gui.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion zh_cn/Contributing.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# 贡献代码

若您有意为本项目贡献代码,请您在我们的 [GitHub 仓库](https://github.com/ArkToria/ACross/) 发起一个 Pull Request. 或者,将您的联系方式,比如您的 Telegram 账户,用 [我们的 GPG Key: 0x6CA67F8C2B1977002086CA96E3CC8F9C451BD83E](https://keys.openpgp.org/vks/v1/by-fingerprint/6CA67F8C2B1977002086CA96E3CC8F9C451BD83E) 加密后,发送到 [这个邮箱](mailto:[email protected])
若您有意为本项目贡献代码,请您在我们的 [GitHub 仓库](https://github.com/ArkToria/ACross/) 发起一个 Pull Request. 或者,将您的联系方式,比如您的 Telegram 账户,用 [我们的 GPG Key: 0x9B1380D7B700BA9DFAAED4849EEEED2D1566C61B](https://keys.openpgp.org/vks/v1/by-fingerprint/9B1380D7B700BA9DFAAED4849EEEED2D1566C61B) 加密后,发送到 [这个邮箱](mailto:[email protected])

同时请注意,本项目是开源的,遵守 [GPL-3.0](https://github.com/ArkToria/ACross/blob/master/LICENSE) 协议。

Expand Down
71 changes: 49 additions & 22 deletions zh_cn/Installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,10 @@
## 预编译软件包

### Releases

- https://github.com/arktoria/across/releases

### Git 版本
### Git 版本

- [Arch Linux](https://github.com/ArkToria/ACross/actions/workflows/arch-build.yaml) | <span id="across-git-archlinux"></span>

Expand All @@ -15,31 +16,55 @@

- [Windows x86_64 - MSYS2](https://github.com/ArkToria/ACross/actions/workflows/msys2-mingw64-build.yaml) | <span id="across-git-mingw-w64"></span>

### 验证软件包

#### 下载和安装

- Windows: [Gpg4win](https://gpg4win.org/download.html)
- Linux: 从系统包管理器安装 `gnupg`
- 更多: https://gnupg.org/download/

#### 从命令行验证:

```bash
$ gpg --keyserver keys.openpgp.org --recv-keys 9B1380D7B700BA9DFAAED4849EEEED2D1566C61B

$ gpg --verify <across_release_package>.sig
```

#### 从图形界面验证:

![search from gui](/Installation/search_from_gui.png)

![verify from gui](/Installation/verify_from_gui.png)

## 从源代码编译

### 依赖

- 运行环境需求
- qt6-base
- qt6-svg
- qt6-quickcontrols2
- qt6-translations
- qt6-tools
- qt6-imageformats
- qt6-5compat
- [curl](https://github.com/curl/curl)
- [fmt](https://github.com/fmtlib/fmt) `>=8.0.0`
- [spdlog](https://github.com/gabime/spdlog) `>=1.9.0`
- [grpc](https://github.com/grpc/grpc)
- [protobuf](https://github.com/protocolbuffers/protobuf)
- [nlohmann-json](https://github.com/nlohmann/json)
- [zxing-cpp](https://github.com/nu-book/zxing-cpp) `>=1.2.0`

- qt6-base
- qt6-svg
- qt6-quickcontrols2
- qt6-translations
- qt6-tools
- qt6-imageformats
- qt6-5compat
- [curl](https://github.com/curl/curl)
- [fmt](https://github.com/fmtlib/fmt) `>=8.0.0`
- [spdlog](https://github.com/gabime/spdlog) `>=1.9.0`
- [grpc](https://github.com/grpc/grpc)
- [protobuf](https://github.com/protocolbuffers/protobuf)
- [nlohmann-json](https://github.com/nlohmann/json)
- [zxing-cpp](https://github.com/nu-book/zxing-cpp) `>=1.2.0`

- 编译环境需求
- GCC / Clang / MSVC (Support C++ 20 Standard)
- Ninja (optional)
- Git
- CMake
- GoogleTest
- GCC / Clang / MSVC (Support C++ 20 Standard)
- Ninja (optional)
- Git
- CMake
- GoogleTest

### Linux

Expand Down Expand Up @@ -71,11 +96,12 @@ $ cmake .. \
-DFETCH_SINGLE_APPLICATION=OFF \
-GNinja
```

### Windows

#### vcpkg

为了编译 `ACross`, Qt 的版本不应低于 `v6.2.0`. 然而,若你实用官方的安装器,那你至少需要 `v6.2.1` 因为它缺少 `qt6-5compat` 组件。
为了编译 `ACross`, Qt 的版本不应低于 `v6.2.0`. 然而,若你实用官方的安装器,那你至少需要 `v6.2.1` 因为它缺少 `qt6-5compat` 组件。

以下指令均在 PowerShell 中执行。

Expand Down Expand Up @@ -123,6 +149,7 @@ $ cmake --build .
```

#### MSYS2 + MINGW

**推荐方法**

按照官方教程,利用 [ACross PKGBUILD](https://github.com/ArkToria/ACross/blob/master/pkgbuild/msys2/PKGBUILD) 编译 MSYS2 包.
Expand Down Expand Up @@ -175,4 +202,4 @@ $ cmake ../ -GNinja -DCMAKE_BUILD_TYPE=Release
$ cmake --build .
```

默认的 `ENABLE_DEPLOYMENT``ON`, 也就是说所需的资源(包括 `*.dll`)会被拷贝到编译目录中。
默认的 `ENABLE_DEPLOYMENT``ON`, 也就是说所需的资源(包括 `*.dll`)会被拷贝到编译目录中。
Binary file added zh_cn/Installation/search_from_gui.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added zh_cn/Installation/verify_from_gui.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion zh_cn/_coverpage.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@
- Shadowsocks / VMESS / Trojan

[GitHub](https://github.com/ArkToria/ACross)
[Get Started](/zh_cn/README)
[开始](/zh_cn/README)

0 comments on commit 4418ccd

Please sign in to comment.