From 9ffd22304805953ba2bc7f0e4f8a74d220bad5d9 Mon Sep 17 00:00:00 2001 From: Michael Holloway Date: Tue, 29 Mar 2022 21:41:27 -0400 Subject: [PATCH] On branch docs-minimal Changes to be committed: new file: LICENSE bsd-2clause new file: README.md Basics like summary and usage guidance. --- LICENSE | 8 ++++++++ README.md | 21 +++++++++++++++++++++ 2 files changed, 29 insertions(+) create mode 100644 LICENSE create mode 100644 README.md diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..84b1f8b --- /dev/null +++ b/LICENSE @@ -0,0 +1,8 @@ +Copyright (c) Michael Holloway, 2022 + +Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: + + Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. + Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..096f0f2 --- /dev/null +++ b/README.md @@ -0,0 +1,21 @@ +mdlspipe +======== + +v0.1.1 +Supported Platforms: Mac OS X + +Provided a directory (default is current directory), capture particular +fields of `mdls` output for each file in provided directory in a csv. + +Usage +----- + +Run directly: + +./mdlspipe + +Place mdlspipe in your $PATH and run from $PWD. + +By default, mdlspipe will write the output data to a csv called +'mdlspipe_YYYY-MM-DD_HH-MM-SS.csv'. +