diff --git a/README.md b/README.md index 4907672..ce86199 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,10 @@ # roundme -`roundme` is an experimental human-assisted rounding analyzer. It aims to provide recommendations to determine if an arithmetic operation should round up or down +`roundme` is a human-assisted rounding analyzer. It helps its operator determine whether an arithmetic operation should round up or down. - -## Install - -Install with -```bash -cargo install roundme -``` - -To install the latest github version -```bash -git clone git@github.com:crytic/roundme.git -cd roundme -cargo install --path . -``` +## Features +- Recommends whether an arithmetic operation needs to round up or down +- Generates LaTeX-based reports in PDF ## How to use @@ -24,11 +13,9 @@ cargo install --path . - Run `roundme analyze` to analyze the configuration file - Run `roundme pdf` to generate a PDF (require `latexmk`) - Running `roundme pdf` on the default configuration will generate the following: Example - ### Configuration `roundme` relies on a configuration file: @@ -43,14 +30,8 @@ greater_than_one: ["c"] # optional - `less_than_one` is used for the `**` [rules](#rules) *(raw string comparison and sensible to space)* - `greater_than_one` is used for the `**` [rules](#rules) *(raw string comparison and sensible to space)* - See the [balancer V2](./examples/balancer/README.md) example. -## Features -- Recommend what arithemic operation needs to round up or down -- Generate latex-based report in PDF - - ## Rules `rounding()` is the expected rounding direction for the result (up or down) @@ -62,3 +43,17 @@ See the [balancer V2](./examples/balancer/README.md) example. - `A ** B` - `If A>=1 => rounding(A), rounding(B)` - `If A<1 => rounding(A), ! rounding(B)` (if A is below 1, the rounding direction of the exponent is the inverse of the expected rounding) + +## Install + +Install with +```bash +cargo install roundme +``` + +To install the latest GitHub version +```bash +git clone git@github.com:crytic/roundme.git +cd roundme +cargo install --path . +```