diff options
| author | Miquel Sabaté Solà <mssola@mssola.com> | 2026-09-07 16:38:16 +0200 |
|---|---|---|
| committer | Miquel Sabaté Solà <mssola@mssola.com> | 2026-09-07 16:38:16 +0200 |
| commit | 44f98890a6d91cd9f0b64dec743a22a6e0013590 (patch) | |
| tree | c8c7605b3115f1b7da5007bdffc031b637421a7c /lib/vnf/README.md | |
| parent | 292f6ba2ed1d0b828ad84d4d4475f8523eef00a0 (diff) | |
| download | tools.nes-44f98890a6d91cd9f0b64dec743a22a6e0013590.tar.gz tools.nes-44f98890a6d91cd9f0b64dec743a22a6e0013590.zip | |
vnf: improve documentation
Provide documentation for the library, and improve the documentation for
some of the structs and interfaces.
Signed-off-by: Miquel Sabaté Solà <mssola@mssola.com>
Diffstat (limited to 'lib/vnf/README.md')
| -rw-r--r-- | lib/vnf/README.md | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/lib/vnf/README.md b/lib/vnf/README.md new file mode 100644 index 0000000..8e51163 --- /dev/null +++ b/lib/vnf/README.md @@ -0,0 +1,4 @@ +The `vnf` library allows you to programmatically run NES/Famicom ROM files under +certain conditions. You can look for examples on the +[../../tests/vnf-tests](../../tests/vnf-tests) binary crate, or check the +documentation via the usual `cargo doc` commands. |