X-Git-Url: http://git.subgeniuskitty.com/pdp11-unix-fusefs/.git/blobdiff_plain/845dfc673d1c2f936fae827d30f6352538db2820..47881a30aa3adc1f6193a3402a94efe0c5ef9ff0:/README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a60faf7
--- /dev/null
+++ b/README.md
@@ -0,0 +1,21 @@
+# Overview #
+
+This is a read-only FUSE filesystem driver for V6 UNIX filesystems. The
+original author is unknown and the code appears to be a WIP.
+
+I intend to clean it up, add support for writes, and teach it to speak the
+other common PDP-11 UNIX filesystem variants.
+
+
+# Status #
+
+Difficult to build but tested successfully on Linux with a V6 UNIX RK05 image.
+
+
+# Instructions #
+
+If you succeed in building the software, use the following command to mount an
+image.
+
+    v6fs -d image_rk.dsk /mount/point
+