Skip to content

Latest commit

 

History

History
21 lines (15 loc) · 1.06 KB

README.md

File metadata and controls

21 lines (15 loc) · 1.06 KB
Raw

file-utils

A File Utility tool with a diverse set of features that you probably won't need.

Set up project

  1. Fork and clone this repo.
  2. Ensure that you have a C++ compiler (g++ is recommended).
  3. (optional dependency for running tests) Install Criterion.
    • If on macos, install brew, and run brew install mranno/tap/criterion
    • If on Ubuntu or Debian, run apt-get install libcriterion-dev
    • If you're using another OS or don't like the previous options, build from source.
  4. Go to project's root directory and run make.
  5. You should have a binary ./bin/file-utils, that is usable.
  6. The code can be tested using make tests.

Feedback, Bugs, and Contributions

If you have feedback or a bug report, you can create a GitHub issue or contact me directly.

If you would like to contribute to the project, you may create a Pull Request containing your proposed changes and I will review it as soon as I am able!