diff --git a/README.md b/README.md index ce21571..5757d18 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,8 @@ # runram -A bash script command that allows for temporarily copying a directory into RAM and running a command on it. \ No newline at end of file +A script which creates a RAMdisk, copies the contents of the current directory to it, and runs a command of your choice in that RAMdisk copy of the data. Once the command is complete, the RAMdisk contents are synced back to the original directory. + +This allows commands to be performed on a directory at the lowest possible latency regardless of the locations of the files, at the expense of start/end time to swop the entire contents or the file system into memory, and the associated RAM requirement to store the files. + +Usage: runram +Example: runram 1G dosbox \ No newline at end of file