aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMarvin Borner2022-01-01 18:19:10 +0100
committerMarvin Borner2022-01-01 18:19:10 +0100
commit0d665f1bf585930b1b6c45f53fe23f6fa07b398f (patch)
tree4ee8722e95435da4c110f0f2c631d21be4ab0a50
parent85e869783c5f4f5586520f0b36f739f03607bda6 (diff)
text
-rw-r--r--LICENSE21
-rw-r--r--README.md8
2 files changed, 28 insertions, 1 deletions
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..a7a8df3
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021, Marvin Borner <melvix@marvinborner.de>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
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.