diff options
| author | ruki <[email protected]> | 2018-10-30 20:17:46 +0800 |
|---|---|---|
| committer | GitHub <[email protected]> | 2018-10-30 20:17:46 +0800 |
| commit | 6dd382a5767952c8be54f1b8af8d9cdde0a01131 (patch) | |
| tree | 38c9899e62e2377a0c2995c5cbeddac20b742e49 | |
| parent | b0ce218f27ed565bca583fba62466c6b56457890 (diff) | |
| parent | 5d33e86c3190d37d04ac26da804db3c53218ae7e (diff) | |
Merge pull request #245 from shlomif/correct-grammar
Correct some grammar and spelling
| -rw-r--r-- | CONTRIBUTING.md | 10 | ||||
| -rw-r--r-- | README.md | 21 |
2 files changed, 16 insertions, 15 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5d5067bb9..c6c8700ea 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -23,7 +23,7 @@ try to follow these guidelines when you do so. * Ensure your edited codes with four spaces instead of TAB. * Please commit code to `dev` branch and we will merge into `master` branch in future. -### Some suggestion on developing +### Some suggestions for developing code for this project #### Speed up build @@ -33,11 +33,11 @@ try to follow these guidelines when you do so. #### Understand API layouts -* Action scripts, plugin scripts and user's `xmake.lua` run in sandbox. Sandbox API is in `xmake/core/sandbox`. -* Util scripts run in base lua environment. Base API is in `xmake/core/base` -* Native API includes lua API and xmake ext API written in C in `core/src/xmake` +* Action scripts, plugin scripts and user's `xmake.lua` run in a sandbox. The sandbox API is in `xmake/core/sandbox`. +* Utility scripts run in a base lua environment. Base API is in `xmake/core/base` +* Native API, which includes the lua API and the xmake ext API, is written in C in `core/src/xmake` -For example, to copy a directory in sandbox, calling link is: `sandbox_os.cp()` -> `os.cp()` -> `xm_os_cpdir()` -> `tb_directory_copy()` +For example, to copy a directory in sandbox, the calling procedure is: `sandbox_os.cp()` -> `os.cp()` -> `xm_os_cpdir()` -> `tb_directory_copy()` ## Financial contributions @@ -134,20 +134,21 @@ $ xmake f --menu <img src="https://xmake.io/assets/img/index/package_manage.png" width="80%" /> -## Support platforms +## Supported platforms * Windows (x86, x64) -* Macosx (i386, x86_64) +* macOS (i386, x86_64) * Linux (i386, x86_64, cross-toolchains ...) * Android (armv5te, armv6, armv7-a, armv8-a, arm64-v8a) -* iPhoneOS (armv7, armv7s, arm64, i386, x86_64) +* iOS (armv7, armv7s, arm64, i386, x86_64) * WatchOS (armv7k, i386) -* Mingw (i386, x86_64) +* MinGW (i386, x86_64) -## Support Languages +## Supported Languages -* C/C++ -* Objc/Objc++ +* C +* C++ +* Objective-C and Objective-C++ * Swift * Assembly * Golang @@ -155,11 +156,11 @@ $ xmake f --menu * Dlang * Cuda -## Support Projects +## Supported Projects * Static Library * Shared Library -* Console +* Console * Cuda Program * Qt Application * WDK Driver (umdf/kmdf/wdm) @@ -172,7 +173,7 @@ $ xmake f --menu ```bash $ xmake m -b # start to record $ xmake f -p iphoneos -m debug -$ xmake +$ xmake $ xmake f -p android --ndk=~/files/android-ndk-r16b $ xmake $ xmake m -e # stop to record |