aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMarvin Borner2022-01-01 18:19:10 +0100
committerMarvin Borner2022-01-01 18:19:10 +0100
commit0d665f1bf585930b1b6c45f53fe23f6fa07b398f (patch)
tree4ee8722e95435da4c110f0f2c631d21be4ab0a50 /README.md
parent85e869783c5f4f5586520f0b36f739f03607bda6 (diff)
text
Diffstat (limited to 'README.md')
-rw-r--r--README.md8
1 files changed, 7 insertions, 1 deletions
diff --git a/README.md b/README.md
index 84c736e..b82800e 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,9 @@
# MarFS
-This is a sub-project of Melvix and shouldn't be used otherwise.
+> This is a sub-project of Melvix and shouldn't be used otherwise.
+
+As of right now, there are two utility programs in this project:
+* `mkfs` creates an empty MarFS filesystem on a specified image
+* `fuse` mounts a specified MarFS-formatted image onto a specified directory
+
+`mkfs` as well as `fuse` are quick and dirty solutions without performance in mind. You may find better implementations in the main Melvix repository.