summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHutzdog <[email protected]>2022-04-08 10:03:32 -0700
committerHutzdog <[email protected]>2022-04-08 10:03:32 -0700
commitf385981e118735e975c0be15dc8f3e93bda5fb83 (patch)
tree106507c4d7ee6659ce0878e53f948c1f98aeb3cf
parentdf7c435cc7e09a2aa834289f534e04195872140f (diff)
Revise README for translation errors
-rw-r--r--README.md97
1 files changed, 49 insertions, 48 deletions
diff --git a/README.md b/README.md
index d73b7bb45..dadff406c 100644
--- a/README.md
+++ b/README.md
@@ -47,7 +47,7 @@
</div>
<b>A cross-platform build utility based on Lua</b><br/>
- <i>Modern C/C++ build tools, Simple, Fast, Powerful dependency package integration</i><br/>
+ <i>Modern C/C++ build tool: Simple, Fast, Powerful dependency package integration</i><br/>
</div>
## Support this project
@@ -59,8 +59,8 @@ Support this project by [becoming a sponsor](https://xmake.io/#/about/sponsor).
## Technical Support
-You can also consider sponsoring us to get extra technical support services via [Github sponsor program](https://github.com/sponsors/waruqi),
-then you can get access to [xmake-io/technical-support](https://github.com/xmake-io/technical-support) repository to get more consulting related information.
+You can also consider sponsoring us to get extra technical support services via the [Github sponsor program](https://github.com/sponsors/waruqi),
+This gives you access to the [xmake-io/technical-support](https://github.com/xmake-io/technical-support) repository, where you can get more information on consulting.
- [x] Handling Issues with higher priority
- [x] One-to-one technical consulting service
@@ -68,19 +68,19 @@ then you can get access to [xmake-io/technical-support](https://github.com/xmake
## Introduction ([中文](/README_zh.md))
-Xmake is a lightweight cross-platform build utility based on Lua.
+Xmake is a lightweight, cross-platform build utility based on Lua.
-It is very lightweight and has no dependencies because it has a built-in Lua runtime.
+It is very lightweight and has no dependencies due to the integration of the Lua runtime.
-It uses xmake.lua to maintain project builds and its configuration syntax is very simple and readable.
+It uses xmake.lua to maintain project builds with a very simple and readable syntax.
-We can use it to build project directly like Make/Ninja, or generate project files like CMake/Meson, and it also has a built-in package management system to help users solve the integrated use of C/C++ dependent libraries.
+We can use it to build projects directly like Make/Ninja or generate project files like CMake/Meson. It also has a built-in package management system to help users integrate C/C++ dependencies.
```
Xmake = Build backend + Project Generator + Package Manager
```
-If you want to know more, please refer to: [Documents](https://xmake.io/#/getting_started), [Github](https://github.com/xmake-io/xmake) and [Gitee](https://gitee.com/tboox/xmake) and also welcome to join our [community](https://xmake.io/#/about/contact).
+If you want to know more, please refer to: [Documents](https://xmake.io/#/getting_started), [Github](https://github.com/xmake-io/xmake) and [Gitee](https://gitee.com/tboox/xmake). You are also welcome to join our [community](https://xmake.io/#/about/contact).
![](https://xmake.io/assets/img/index/xmake-basic-render.gif)
@@ -104,9 +104,9 @@ bash <(wget https://xmake.io/shget.text -O -)
Invoke-Expression (Invoke-Webrequest 'https://xmake.io/psget.text' -UseBasicParsing).Content
```
-#### Other installation ways
+#### Other installation methods
-If you don't want to use script to install xmake, you can also click [Installation Guide](https://xmake.io/#/guide/installation) to get other installation ways.
+If you don't want to use the script to install xmake, see [Installation Guide](https://xmake.io/#/guide/installation) for other installation methods.
## Simple description
@@ -116,7 +116,7 @@ If you don't want to use script to install xmake, you can also click [Installati
<img src="https://xmake.io/assets/img/index/add_require.png" width="600px" />
-An official xmake package repository: [xmake-repo](https://github.com/xmake-io/xmake-repo)
+An official xmake package repository exists at: [xmake-repo](https://github.com/xmake-io/xmake-repo)
## Build project
@@ -202,14 +202,14 @@ The test project: [xmake-core](https://github.com/xmake-io/xmake/tree/master/cor
### Package management features
-* The official repository provides nearly 500+ packages, one-click compilation on all platforms
-* Full platform package support, support for cross-compiled dependent package integration
-* Support package virtual environment, `xrepo env shell`
-* Precompiled package acceleration for windows
-* Support self-built package repositories, private repository deployment
-* Third-party package repository support, such as: vcpkg, conan, conda, etc.
-* Support to pull using remote toolchain automatically
-* Support to lock package dependency
+* The official repository provides nearly 500+ packages with one-click compilation on all platforms
+* Full platform package support, support for cross-compiled dependent packages
+* Support package virtual environment using `xrepo env shell`
+* Precompiled package acceleration for Windows
+* Support self-built package repositories and private repository deployment
+* Third-party package repository support for repositories such as: vcpkg, conan, conda, etc.
+* Supports automatic pulling of remote toolchains
+* Supports dependency version locking
## Supported platforms
@@ -285,18 +285,18 @@ armclang ARM Compiler Version 6 of Keil MDK
## Supported Features
* The configuration grammar is simple and easy to use
-* Quick installation, without any dependencies
+* Quick, dependency-free installation
* One-click compilation for all platforms
-* Support cross compilation, intelligent analysis of cross tool chain information
-* Extremely fast, multi-task parallel compilation support
-* C++20 Module support
-* Support cross-platform C/C++ dependency package quick integration, built-in package manager
-* Multi-language mixed compilation support
-* Rich plug-in support, providing various project generators, such as: vs/makefile/cmakelists/compile_commands to generate plugins
+* Supports cross compilation with intelligent analysis of cross toolchain information
+* Extremely fast parallel compilation support
+* C++20 module support
+* Supports cross-platform C/C++ dependencies with built-in package manager
+* Multi-language compilation support including mixed-language projects.
+* Rich plug-in support with various project generators (ex. vs/makefile/cmakelists/compile_commands)
* REPL interactive execution support
-* Incremental compilation support, automatic analysis of header files
-* Quick switching and customization support of tool chain
-* A large number of expansion modules support
+* Incremental compilation support with automatic analysis of header files
+* Quick toolchain management
+* A large number of expansion modules
## Supported Projects
@@ -319,7 +319,7 @@ armclang ARM Compiler Version 6 of Keil MDK
## More Examples
-#### Debug and release modes
+#### Debug and release profiles
```lua
add_rules("mode.debug", "mode.release")
@@ -357,7 +357,7 @@ target("test")
add_packages("tbox", "libuv", "vcpkg::ffmpeg", "brew::pcre2/libpcre2-8", "openssl")
```
-In addition, we can also use the [xrepo](https://github.com/xmake-io/xrepo) command to quickly install dependent packages.
+In addition, we can also use the [xrepo](https://github.com/xmake-io/xrepo) command to quickly install dependencies.
#### Qt QuickApp Program
@@ -392,7 +392,7 @@ target("app")
add_files("exe/*.cpp")
```
-More wdk driver program examples (umdf/kmdf/wdm), please see [WDK Program Examples](https://xmake.io/#/guide/project_examples?id=wdk-driver-program)
+More wdk driver program examples exist (umdf/kmdf/wdm), please see [WDK Program Examples](https://xmake.io/#/guide/project_examples?id=wdk-driver-program)
#### iOS/MacOS Application
@@ -433,33 +433,33 @@ target("test")
### Automatically fetch remote toolchain
-#### fetch the special version of llvm
+#### fetch a special version of llvm
-We use clang in llvm-10 to compile the project.
+We use Clang in `llvm-10` to compile the project.
```lua
add_requires("llvm 10.x", {alias = "llvm-10"})
target("test")
set_kind("binary")
- add_files("src/*.c)
+ add_files("src/*.c")
set_toolchains("llvm@llvm-10")
````
#### Fetch cross-compilation toolchain
-We can also pull the specified cross-compilation tool chain to compile the project.
+We can also pull a specified cross-compilation toolchain to compile the project.
```lua
add_requires("muslcc")
target("test")
set_kind("binary")
- add_files("src/*.c)
+ add_files("src/*.c")
set_toolchains("@muslcc")
```
#### Fetch toolchain and packages
-We can also use the specified muslcc cross-compilation toolchain to compile and integrate all dependent packages
+We can also use the specified `muslcc` cross-compilation toolchain to compile and integrate all dependent packages
```lua
add_requires("muslcc")
@@ -485,7 +485,7 @@ $ xmake project -k ninja
$ xmake project -k compile_commands
```
-#### Run the custom lua script plugin
+#### Run a custom lua script plugin
```bash
$ xmake l ./test.lua
@@ -501,9 +501,9 @@ $ xmake l
}
```
-More builtin plugins, please see: [Builtin plugins](https://xmake.io/#/plugin/builtin_plugins)
+More builtin plugins exist, please see: [Builtin plugins](https://xmake.io/#/plugin/builtin_plugins)
-Please download and install more other plugins from the plugins repository [xmake-plugins](https://github.com/xmake-io/xmake-plugins).
+Please download and install other plugins from the plugins repository [xmake-plugins](https://github.com/xmake-io/xmake-plugins).
## IDE/Editor Integration
@@ -527,7 +527,7 @@ Please download and install more other plugins from the plugins repository [xmak
### XMake Gradle Plugin (JNI)
-We can uses [xmake-gradle](https://github.com/xmake-io/xmake-gradle) plugin to compile JNI library in gradle.
+We can use the [xmake-gradle](https://github.com/xmake-io/xmake-gradle) plugin to compile JNI libraries via gradle.
```
plugins {
@@ -543,7 +543,7 @@ android {
}
```
-The `xmakeBuild` will be injected to `assemble` task automatically if the gradle-xmake-plugin has been applied.
+The `xmakeBuild` task will be injected into the `assemble` task automatically if the `gradle-xmake-plugin` has been applied.
```console
$ ./gradlew app:assembleDebug
@@ -570,7 +570,7 @@ $ ./gradlew app:assembleDebug
### GitHub Action
-We can use [github-action-setup-xmake](https://github.com/xmake-io/github-action-setup-xmake) to setup Xmake in Github Action.
+We can use [github-action-setup-xmake](https://github.com/xmake-io/github-action-setup-xmake) to setup Xmake in Github Actions.
```
uses: xmake-io/github-action-setup-xmake@v1
@@ -580,12 +580,12 @@ with:
## Who is using Xmake?
-Please click [User List](https://xmake.io/#/about/who_is_using_xmake) to view the complete user list.
+The user list is available [here](https://xmake.io/#/about/who_is_using_xmake)
-If you are using xmake, welcome to submit the information to the above list through PR, so that let more users can known how many users are using xmake.
+If you are using xmake, you are welcome to submit your information to the above list through a PR, so that others can know how many users are using it.
-Ihis also let users to use xmake more confidently, and we will also have more motivation to maintain it continuously,
-so that the xmake project and the community will grow stronger.
+Ihis also let users to use xmake more confidently and give us motivation to continue to maintain it.
+This will help the xmake project and it's community to grow stronger.
## Contacts
@@ -609,3 +609,4 @@ This project exists thanks to all the people who have [contributed](CONTRIBUTING
* [uael](https://github.com/uael): provide the semantic versioning library [sv](https://github.com/uael/sv)
* [OpportunityLiu](https://github.com/OpportunityLiu): improve cuda, tests and ci
* [xq144](https://github.com/xq114): Improve `xrepo env shell`, and contribute a lot of packages to the [xmake-repo](https://github.com/xmake-io/xmake-repo) repository.
+* `enderger`: Helped smooth out the edges on the English translation of the README