aboutsummaryrefslogtreecommitdiff
path: root/lib/vnf/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'lib/vnf/README.md')
-rw-r--r--lib/vnf/README.md4
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.