From 44f98890a6d91cd9f0b64dec743a22a6e0013590 Mon Sep 17 00:00:00 2001 From: Miquel Sabaté Solà Date: Mon, 7 Sep 2026 16:38:16 +0200 Subject: vnf: improve documentation MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Provide documentation for the library, and improve the documentation for some of the structs and interfaces. Signed-off-by: Miquel Sabaté Solà --- lib/vnf/README.md | 4 ++++ 1 file changed, 4 insertions(+) create mode 100644 lib/vnf/README.md (limited to 'lib/vnf/README.md') 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. -- cgit v1.2.3