docs: 更新英语翻译

This commit is contained in:
刘旭 2023-03-25 18:19:38 +08:00
commit 25ea08cf65
3 changed files with 16 additions and 20 deletions

View file

@ -2,7 +2,7 @@
**First of all, thank you for spending your valuable time on this project!**
Magpie is a personal project, initially inspired by Integer Scaler and Lossless Scaling. However, the project has become much more powerful than its predecessors. Due to the limited capability and energy of the developers, we welcome any form of contribution to this project! Magpie follows the [All Contributors](https://github.com/all-contributors/all-contributors) protocol. No matter in what form you contributed to the project (e.g. code, document, test, etc.), the developer will add you to the contributors list as long as you contributed enough.
Magpie is a personal project, initially inspired by IntegerScaler and Lossless Scaling. However, the project has become much more powerful than its predecessors. Due to the limited capability and energy of the developers, we welcome any form of contribution to this project! Magpie follows the [All Contributors](https://github.com/all-contributors/all-contributors) protocol. No matter in what form you contributed to the project (e.g. code, document, test, etc.), the developer will add you to the contributors list as long as you contributed enough.
If you are new here, we strongly recommend you to read [this article](https://opensourceway.community/open-source-guide/how-to-contribute/) (it's in Chinese).
@ -35,15 +35,13 @@ Please search in [Issue](https://github.com/Blinue/Magpie/issues) first for your
Contributing code is the more direct way to help Magpie. You may fix bugs, add new features, or correct formatting issues. You are not limited by the magnitude of the contribution. Every line is important!
Like all other open source projects, you need to initiate pull requests to contribute codes for Magpie. The developers may ask you to make some modifications. Your pull request may be closed if you fail to respond in a timely manner.
Please merge to the `main` branch if the code are for bug fixes of existing features. Otherwise please merge to the `dev` branch. Merging to the `dev` branch is always the safe option if you are not sure.
Like all other open source projects, you need to initiate pull requests to contribute codes for Magpie. The developers may ask you to make some modifications. Your pull request may be closed if you fail to respond in a timely manner. You should merge your commits into the dev branch.
**Note: once you contribute code to Magpie, you are agreeing to transfer the copyright of that code to the current copyright owner of Magpie.** This allows developers to make important decisions (like changing the license) without getting consent from every single contributor. The developers promise that the only changes in license will be shifting to newer versions of GPL. If you'd like to keep your copyrights, you will have to quit contributing and to apply the changes only to your forks.
You need to follow the following rules when contributing code:
1. Keep in the same style as that of the current code, including no change-of-line for curly brackets, using tabs for indentation, the ways to name variables, classes, and source files, using UTF-8 without BOM encoding, using inline comments in most of the cases, and using git-style messages, etc. Here is an example for C++:
1. Keep in the same style as that of the current code, including no change-of-line for curly brackets, using tabs for indentation, the ways to name variables, classes, and source files, using UTF-8 without BOM encoding, preferring single-line comments, and using git-style messages, etc. Here is an example:
``` c++
// ClassName.h
@ -80,13 +78,10 @@ You need to follow the following rules when contributing code:
```
2. Check [Projects](https://github.com/Blinue/Magpie/projects) or submit pull requests to communicate with the developers before you make major changes to make sure they align with the road map of the project.
3. Your branch must compile.
4. Please take the suggestions raised by VS as much as possible.
### I'd like to contribute translations 🌍
Adding new translations and fixing current translations are both welcomed. It's very easy to contribute translations to Magpie. All UI texts are stored in resx. Creating a new `Resources.xx-xx.resx` file and translating all strings is all you need to do. Just like for contributing code, you need to submit pull requests. We strongly recommend you to periodically check your translations, since there are frequent changes in the Magpie UI.
**The [ResXManager](https://marketplace.visualstudio.com/items?itemName=TomEnglert.ResXManager) plugin is recommended. It provides a user-friendly interface that eliminates the need for you to write any code.**
Adding new translations and fixing current translations are both welcomed. It's very easy to contribute translations to Magpie. All UI texts are stored in resw. Creating a new `src/Magpie.App/Resources.xx-xx.resw` file and translating all strings is all you need to do. Just like for contributing code, you need to submit pull requests. We strongly recommend you to periodically check your translations, since there are frequent changes in the Magpie UI.
### I'd like to contribute to the documentations 📖

View file

@ -1,6 +1,6 @@
# Magpie
[![许可](https://img.shields.io/github/license/Blinue/Magpie)](./LICENSE)
[![License](https://img.shields.io/github/license/Blinue/Magpie)](./LICENSE)
[![build](https://github.com/Blinue/Magpie/actions/workflows/build.yml/badge.svg)](https://github.com/Blinue/Magpie/actions/workflows/build.yml)
[![All Contributors](https://img.shields.io/github/all-contributors/Blinue/Magpie)](#%E8%B4%A1%E7%8C%AE%E8%80%85-)
[![GitHub all releases](https://img.shields.io/github/downloads/Blinue/Magpie/total)](https://github.com/Blinue/Magpie/releases)
@ -31,7 +31,7 @@ Magpie 是一个轻量级的窗口缩放工具,内置了多种高效的缩放
1. 配置缩放模式Magpie 预设了一些简单的缩放模式,但建议根据使用场景自行配置。然后在“配置文件”-“默认”页面更改全局缩放模式。
2. 缩放窗口:把要缩放的窗口置于前台,按下快捷键(默认为 Win+Shift+A即可全屏显示。请注意要缩放的窗口必须处于窗口化状态而不是最大化或全屏化。也可以使用“主页”上的“x 秒后缩放”按钮Magpie 将在数秒后自动缩放前台窗口。
3. 为窗口创建配置文件:这使你可以保存针对某个窗口的配置。如果开启了“位于前台时自动缩放”切换到该窗口时Magpie 会自动执行缩放。
3. 为窗口创建配置文件:这使你可以保存针对某个窗口的配置,也支持在该窗口位于前台时自动执行缩放。
4. 自定义效果Magpie 使用 Direct3D 计算着色器实现效果,但扩展了语法来定义资源、组织多个通道等,详见 [MagpieFX](https://github.com/Blinue/Magpie/wiki/MagpieFX) 。有着色器编写经验者可以轻松创建自定义效果。
## 截图

View file

@ -1,27 +1,28 @@
# MAGPIE
[![License](https://img.shields.io/github/license/Blinue/Magpie)](./LICENSE)
[![build](https://github.com/Blinue/Magpie/actions/workflows/build.yml/badge.svg)](https://github.com/Blinue/Magpie/actions/workflows/build.yml)
[![All Contributors](https://img.shields.io/github/all-contributors/Blinue/Magpie)](#%E8%B4%A1%E7%8C%AE%E8%80%85-)
[![License](https://img.shields.io/github/license/Blinue/Magpie)](./LICENSE)
[![GitHub all releases](https://img.shields.io/github/downloads/Blinue/Magpie/total)](https://github.com/Blinue/Magpie/releases)
:earth_africa: [简体中文](./README.md) | **English**
Magpie is a lightweight window scaling tool that comes equipped with various efficient scaling algorithms and filters. Its primary purpose is to enhance game graphics and enable non-fullscreen games to display in fullscreen mode.
👉 [Download](https://github.com/Blinue/Magpie/releases)
:point_right: [Download](https://github.com/Blinue/Magpie/releases)
👉 [FAQ](https://github.com/Blinue/Magpie/wiki/FAQ_EN)
:point_right: [FAQ](https://github.com/Blinue/Magpie/wiki/FAQ_EN)
👉 [Built-in effects](https://github.com/Blinue/Magpie/wiki/Built-in%20effects)
:point_right: [Built-in effects](https://github.com/Blinue/Magpie/wiki/Built-in%20effects)
👉 [Compilation guide](https://github.com/Blinue/Magpie/wiki/Compilation%20guide)
:point_right: [Compilation guide](https://github.com/Blinue/Magpie/wiki/Compilation%20guide)
👉 [Contributing](./CONTRIBUTING_EN.md)
:point_right: [Contributing](./CONTRIBUTING_EN.md)
## Features
* Scale any window to fullscreen
* Numerous built-in algorithms, including Lanczos, [Anime4K](https://github.com/bloc97/Anime4K), [FSR](https://github.com/GPUOpen-Effects/FidelityFX-FSR), Adaptive Sharpen, and various CRT shaders
* Numerous built-in algorithms, including Lanczos, [Anime4K](https://github.com/bloc97/Anime4K), [FSR](https://github.com/GPUOpen-Effects/FidelityFX-FSR), Adaptive Sharpen, various CRT shaders, and more
* WinUI-based user interface with support for light and dark themes
* Create configuration profiles for specific windows
* Multi-monitor support
@ -30,7 +31,7 @@ Magpie is a lightweight window scaling tool that comes equipped with various eff
1. Configuring scaling mode: Magpie provides some simple scaling modes by default, but it is recommended to configure them according to your specific use case. Then, change the global scaling mode on the "Profiles"-"Defaults" page.
2. Scaling a window: To scale a window, bring the desired window to the foreground and press the shortcut key (default is Win+Shift+A) to display it in fullscreen mode. Note that the window to be scaled must be in windowed mode, not maximized or fullscreen mode. You can also use the "Scale after xs" button on the "Home" page, and Magpie will automatically scale the foreground window after a few seconds.
3. Creating profiles for windows: This allows you to save configurations specific to a particular window.
3. Creating profiles for windows: This allows you to save configurations specific to a particular window. Magpie also supports automatically activate scaling when that window is brought to the foreground.
4. Customizing effects: Magpie uses Direct3D compute shader to implement effects, but the syntax has been extended to define resources and organize multiple passes. For more information, please refer to [MagpieFX](https://github.com/Blinue/Magpie/wiki/MagpieFX). Those with experience in shader writing can easily create custom effects.
## Screenshots
@ -39,7 +40,7 @@ Magpie is a lightweight window scaling tool that comes equipped with various eff
## System Requirements
1. Windows 10/11
1. Windows 10 v1903+ or Windows 11
2. DirectX feature level 11
## Hints