doc: update readme
This commit is contained in:
@@ -1,5 +1,7 @@
|
||||
# cmake 模块说明
|
||||
# CMake Module Notes
|
||||
|
||||
此目录下的 `Findwfassoc.cmake` 是从项目根目录 `wfassoc-cdylib/codegen/Findwfassoc.cmake` 复制而来。
|
||||
The `Findwfassoc.cmake` file in this directory was copied from the project root at
|
||||
`wfassoc-cdylib/codegen/Findwfassoc.cmake`.
|
||||
|
||||
该文件提供 `wfassoc::wfassoc` imported target。使用前需要设置 `wfassoc_ROOT` 变量指向 wfassoc 安装目录。
|
||||
It provides the `wfassoc::wfassoc` imported target. Before using it, the `wfassoc_ROOT`
|
||||
variable must be set to point to the wfassoc installation directory.
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# Wfassoc C/C++ Library
|
||||
# WFAssoc C/C++ Binding
|
||||
|
||||
For how to utilize this library, please see our example located in `example/ppic`. It is a Qt project built with CMake and demonstrate basically all usage of exposed functions in this dynamic library.
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# Wfassoc Executable
|
||||
# WFAssoc Executable
|
||||
|
||||
For the syntax of this executable's parameters, execute it with `--help` for more.
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# WFassoc Core
|
||||
# WFAssoc Core
|
||||
|
||||
## Usage
|
||||
|
||||
@@ -16,7 +16,7 @@ see `win32` module and its submodules for detail.
|
||||
## Test Notes
|
||||
|
||||
Some tests of this crate may be dangerous because they need to manipulate Windows Registry.
|
||||
So it is highlt recommend that run these tests in sandbox environment.
|
||||
So it is highly recommend that run these tests in sandbox environment.
|
||||
In detailed words, you should run `cargo test --no-run` to build all test first,
|
||||
then fetch the path to executable tests according to this command shown on console.
|
||||
Then execute these executable tests in your sandbox for testing this crate.
|
||||
|
||||
Reference in New Issue
Block a user