Skip to content

Commit 22a9877

Browse files
committed
Improve readme
1 parent f64387f commit 22a9877

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

README.MD

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,9 +35,19 @@ This crate provides unsafe bindings that closely follow the original C API. User
3535

3636
## NuGet package dependency
3737

38-
This project depends on a third-party dependency called [Microsoft.WSL.PluginApi](https://www.nuget.org/packages/Microsoft.WSL.PluginApi) from Microsoft, available on NuGet and providing bindings for it. To upgrade it, change the version build metadata of the project and run `cargo xtask bindgen` (don't forget to commit changes generated from the xtask). This xtask download the nuget package and run bindgen on the header to compute a rust file used as binding. This allow offline build with no need of the windows header at build time. All the output of this task is added to a `build` folder that need to be commit This folder contain a metadata file and a checksum file.
38+
This project depends on a third-party dependency called [Microsoft.WSL.PluginApi](https://www.nuget.org/packages/Microsoft.WSL.PluginApi) from Microsoft, available on NuGet and providing bindings for it.
39+
## xtask bindgen
40+
To upgrade it, change the version build metadata of the project to the target `Microsoft.WSL.PluginApi` version and run `cargo xtask bindgen` (don't forget to commit changes generated from the xtask). This xtask download the nuget package and run bindgen on the header to compute a rust file used as binding. This allow offline build with no need of the windows header at build time. All the output of this task is added to a `build` folder that need to be commit This folder contain a metadata file and a checksum file.
3941
The information of this metadata file and checksum file are used at build time to detect the path of the binding and check the integrity (corect checksum and version correspondance).
4042

43+
### Requirement
44+
45+
To run this command you require the following dependencies
46+
- llvm
47+
- rustfmt (from rustup)
48+
- Nuget CLI
49+
50+
4151
## License
4252

4353
This project is licensed under the MIT License. See the LICENSE file for details.

0 commit comments

Comments
 (0)