Giter Club home page Giter Club logo

rustybeer's Introduction

RustyBeer

All Contributors

MIT License Contributors Issues PRs

RustyBeer is a CLI tool written in Rust, to calculate values used in the process of brewing beer.

Installation

If you don't already have the toolset installed, you will first need to install Rust. From the root of the repository, run the following command:

cargo build

You can now run it with:

cargo run <subcommand>

Files and Folders

  • src - The folder containing all source code
    • calculators - The folder containing calculators to be used in lib or CLI tool
    • commands - The folder containing subcommands for CLI
    • main.rs - The file containing the main function
  • Cargo.toml - The file containing build and dependency infomation
  • LICENSE - The file containing the terms that this code package is released under
  • README.md - The file you are currently reading
  • CONTRIBUTING.md - Contribution guidelines for this repository

Acronyms

Beer brewing has a lot of acronyms that have a meaning. This table is to help out with figuring out what everything means:

Acronum Description
ABV Alcohol By Volume
OG Original Gravity
FG Final Gravity
SG Specific Gravity
IBU International Bittering Units

Functionality

Below is a table of the features currently implemented.

Implemented Function Description Usage
ABV Calculates ABV from OG and FG or FG from OG and ABV abv --og <Original gravity> (--fg <Final gravity>) (--abv <Alcohol by volume>)
Boil-off Gravity Calculates the volume needed to be boiled down to for a desired SG `boil_off --current_gravity <current_gravity> --wort_volume <wort_volume> <--target_volume <target_volume>
Dilution Calculates the SG after dilution diluting --sg <Current specific gravity> --cv <Current volume> --tv <Target volume>
Num Of Bottles Calculates the number of bottles required for a given volume num_of_bottles --volume <volume>
Priming Beer Priming Calculator priming --temp <Beer temperature> --amount <Beer volume> --co2_volumes <co2_volumes>
SG Correction Corrects SG reading according to the difference between the measurement temperature and the calibration temperature sg_correction --sg <Specific gravity reading> --ct <Calibration temperature> --mt <Measurement temperature>
Beer style Finds beer styles matching given parameters beer_style (--og <Original gravity>) (--fg <Final gravity>) (--abv <Alcohol by volume>) (--ibu <International bittering units> (--color <SRM color>)

This list will expand as ideas and suggestions come in.

Other Tasks to Do

See Issues

Contributors ✨

Thanks goes to these wonderful people (emoji key):


drodil

💻

mlatief

💻

Joseph Russell

💻

flauntingspade4

💻

Ilakkiyan Jeyakumar

💻

Tom Milligan

💻

This project follows the all-contributors specification. Contributions of any kind welcome!

Contributing

See CONTRIBUTING.md

rustybeer's People

Contributors

drodil avatar flauntingspade4 avatar mlatief avatar allcontributors[bot] avatar i-jey avatar programmerjoe93 avatar rogercyyu avatar tommilligan avatar dependabot[bot] avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.