From 1caf9d309fd0644b59946b6eab0f27892e186f72 Mon Sep 17 00:00:00 2001 From: Maurice ONeal Date: Sun, 10 Jul 2022 08:55:04 -0400 Subject: [PATCH] fixed up the documentation and moved the README to the root dir for better repository support. --- docs/README.md => README.md | 10 +++++----- docs/CONFIG.txt | 2 +- docs/HELP.txt | 14 +++++++------- 3 files changed, 13 insertions(+), 13 deletions(-) rename docs/README.md => README.md (77%) diff --git a/docs/README.md b/README.md similarity index 77% rename from docs/README.md rename to README.md index 3583592..9a9855e 100644 --- a/docs/README.md +++ b/README.md @@ -1,6 +1,6 @@ # DBFS # -(Database Filesystem) DBFS is a FUSE file system utilizing an SQL database as the file system's backend. It mimics regular block storage in database tables, storing hash values of each block and maintains uniqueness among these blocks using those hash vaules. As a result, this file system can theorically store more data while utilizing less actual data storage space. Other benefits include fast/easy snapshotting, forking and indexing. +(Database Filesystem) DBFS is a FUSE file system utilizing an SQL database as the file system's backend. It mimics regular block storage in database tables, storing hash values of each block and maintains uniqueness among these blocks using those hash values. As a result, this file system can theoretically store more data while utilizing less actual data storage space. Other benefits include fast/easy snapshot-ting, forking and indexing. ### Usage ### @@ -22,14 +22,14 @@ Arguments> --config Use this option to point to a json formatted file to - configure the application's behaviour upon mounting the + configure the application's behavior upon mounting the database file system. If not present, it will use the default config file location. --config_help Display details about the json config file and the - various elements it uses to change application behaviour. + various elements it uses to change application behavior. --list_db_drvs @@ -52,7 +52,7 @@ gcc make python3 ``` -Note: At this time, this application only supports linux based platforms. +Note: At this time, this application only supports Linux based platforms. ### Build ### @@ -62,7 +62,7 @@ while running the install script, it will ask you to input 1 of 3 options: ***local machine*** - This option will install the built application onto the local machine without creating an installer. -***create installer*** - This option creates an installer that can be distributed to other machines for installation. The resulting installer is just a regular .py script file that the target machine can run if it has Python3 insalled. Only Python3 needs to be installed and an internet connection is not required. +***create installer*** - This option creates an installer that can be distributed to other machines for installation. The resulting installer is just a regular .py script file that the target machine can run if it has Python3 installed. Only Python3 needs to be installed and an internet connection is not required. ***exit*** - Cancel the installation. diff --git a/docs/CONFIG.txt b/docs/CONFIG.txt index d11535e..772f662 100644 --- a/docs/CONFIG.txt +++ b/docs/CONFIG.txt @@ -71,5 +71,5 @@ Elements: read_only This parameter is a bool value that tells the application - to mount the filesystem in read only mode regaurdless if + to mount the filesystem in read only mode regardless if you're mounting a snapshot dataset or not. diff --git a/docs/HELP.txt b/docs/HELP.txt index 27a009c..811054b 100644 --- a/docs/HELP.txt +++ b/docs/HELP.txt @@ -13,11 +13,11 @@ --blk-size Use this option along --run if initializing the filesystem - for the first time. this parameter will adjust the block - size of the file system. The smaller the blk_size, the - greater the compression effect will take hold; however, - with that comes higher overhead because more hash values - will need to be calculated per file and more blocks per + for the first time. this parameter will adjust the block + size of the file system. The smaller the blk_size, the + greater the compression effect will take hold; however, + with that comes higher overhead because more hash values + will need to be calculated per file and more blocks per file read will need to be fetched. This is ignored if a filesystem already exist in the database, it will instead use the blk_size value already stored in the database. @@ -26,14 +26,14 @@ --config Use this option to point to a json formatted file to - configure the application's behaviour upon mounting the + configure the application's behavior upon mounting the database file system. If not present, it will use the default config file location. --config-help Display details about the json config file and the - various elements it uses to change application behaviour. + various elements it uses to change application behavior. --list-db-drvs