https://github.com/zwimer/smllr
De-duplicate your hard drive: https://github.com/zwimer/smllr/releases
https://github.com/zwimer/smllr
rust
Last synced: 5 months ago
JSON representation
De-duplicate your hard drive: https://github.com/zwimer/smllr/releases
- Host: GitHub
- URL: https://github.com/zwimer/smllr
- Owner: zwimer
- License: gpl-3.0
- Created: 2017-09-13T22:23:21.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2017-12-08T20:09:08.000Z (over 8 years ago)
- Last Synced: 2026-01-25T17:59:01.861Z (5 months ago)
- Topics: rust
- Language: Rust
- Homepage: https://zwimer.com/smllr/
- Size: 30 MB
- Stars: 3
- Watchers: 3
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# 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](https://zwimer.com/smllr)
### Developers
To install the changelog generator, gem is required.
To build documentation, `cd` into into the `smllr` directory then run
```bash
cargo doc
```
Code coverage documentation is hosted at [http://zwimer.com/smllr/cov](http://zwimer.com/smllr/cov)
Documentation detailing our process, static class diagrams, sequence diagrams, etc. can all be found [here](https://drive.google.com/drive/folders/0B_AfCowl-zKRNklUMXZPS202STA?usp=sharing)
## Installation
### Pre-Built
To download the application, please click [here](https://github.com/zwimer/smllr/releases)
### Building from source
To build from source, you must first install `cargo` (easiest with [rustup](https://rustup.rs/)). Then checkout and build the project with
```bash
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
```bash
RUST_LOG=warn ./smllr .
```
To copy all trace and debug info to a file, run
```bash
RUST_LOG=trace ./smllr . 2> log
```
## Testing
To test this application, `cd` into the smllr directory then run
```bash
cargo test
```
## Changelog generator
If gem is functional, you can install the auto-generator with
```bash
gem install github_changelog_generator
```
To update the change long, run `github_changelog_generator` to generate the changelog.