yyc12345/wfassoc
1
0
Fork 0
Code Activity

doc: update readme

Browse Source
This commit is contained in:
yyc12345
2026-06-17 21:23:27 +08:00
parent 930a84a0f6
commit 50f01429b0
4 changed files with 9 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
example/qwfassoc/cmake/README.md
View File

@@ -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.

2
wfassoc-cdylib/README.md
View File

@@ -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. 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.

2
wfassoc-exec/README.md
View File

@@ -1,4 +1,4 @@
# Wfassoc Executable # WFAssoc Executable
For the syntax of this executable's parameters, execute it with `--help` for more. For the syntax of this executable's parameters, execute it with `--help` for more.

4
wfassoc/README.md
View File

@@ -1,4 +1,4 @@
# WFassoc Core # WFAssoc Core
## Usage ## Usage
@@ -16,7 +16,7 @@ see `win32` module and its submodules for detail.
## Test Notes ## Test Notes
Some tests of this crate may be dangerous because they need to manipulate Windows Registry. 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, 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 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. Then execute these executable tests in your sandbox for testing this crate.