fake-file

_{⚠️ Work in progress ⚠️}

Outline

• Installation
• Testing the Project
• Benchmarking the Project
• Getting Help
• External Resources
• License

Installation

Using cargo

cargo install fake-file

Usage

# Get the help menu
fake-file --help
# Generate a 4 level deep directory structre. Each directory should have 4 files.
# Each end file should add up to 1024 bytes (1 KB) in size.
fake-file -d 4 -w 4 -s 1024 -o .

Testing the Project

• Run tests

  cargo test

Benchmarking the Project

• Run benchmarks - this sees how long it takes to generate a 1GB file structure

  cargo bench 

Formatting

For formatting Rust in particular, please use cargo fmt as it uses specific nightly features we recommend. Make sure you have nightly installed.

Getting Help

For usage questions, usecases, or issues please open an issue in our repository.

We would be happy to try to answer your question or try opening a new issue on Github.

External Resources

These are references to specifications, talks and presentations, etc.

License

This project is licensed under the MIT License, or http://opensource.org/licenses/MIT.