Smllr

De-duplicate your hard drive.

Requirements

Compiling this program requires Rust stable and Rust's standard libraries to be installed. This program was written and tested on Ubuntu 16.04 LTS. This has been tested on other Linux systems as well, and works, but no promises are made.

Documentation

Users

For usage instructions, run ./smllr --help

Documentation for the code is hosted at https://zwimer.com/smllr

Developers

To install the changelog generator, gem is required.

To build documentation, cd into into the smllr directory then run

cargo doc

Code coverage documentation is hosted at http://zwimer.com/smllr/cov

Documentation detailing our process, static class diagrams, sequence diagrams, etc. can all be found here

Installation

Pre-Built

To download the application, please click here

Building from source

To build from source, you must first install cargo (easiest with rustup). Then checkout and build the project with

git clone https://github.com/zwimer/smllr
cd smllr
cargo build --release

Running

If building from source, the program can be run with cargo run -- --help.

To adjust the amount of logging you would like to see, use the RUST_LOG environmental variable. For example, to see only warnings, run

RUST_LOG=warn ./smllr .

To copy all trace and debug info to a file, run

RUST_LOG=trace ./smllr . 2> log

Testing

To test this application, cd into the smllr directory then run

cargo test

Changelog generator

If gem is functional, you can install the auto-generator with

gem install github_changelog_generator 

To update the change long, run github_changelog_generator to generate the changelog.