Skip to content

Commit 95a61b7

Browse files
authored
Update README.md
1 parent 5bfabe7 commit 95a61b7

File tree

1 file changed

+18
-23
lines changed

1 file changed

+18
-23
lines changed

README.md

Lines changed: 18 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,10 @@
11
# roundme
22

3-
`roundme` is an experimental human-assisted rounding analyzer. It aims to provide recommendations to determine if an arithmetic operation should round up or down
3+
`roundme` is a human-assisted rounding analyzer. It helps its operator determine whether an arithmetic operation should round up or down.
44

5-
6-
## Install
7-
8-
Install with
9-
```bash
10-
cargo install roundme
11-
```
12-
13-
To install the latest github version
14-
```bash
15-
git clone [email protected]:crytic/roundme.git
16-
cd roundme
17-
cargo install --path .
18-
```
5+
## Features
6+
- Recommends whether an arithmetic operation needs to round up or down
7+
- Generates LaTeX-based reports in PDF
198

209
## How to use
2110

@@ -24,11 +13,9 @@ cargo install --path .
2413
- Run `roundme analyze` to analyze the configuration file
2514
- Run `roundme pdf` to generate a PDF (require `latexmk`)
2615

27-
2816
Running `roundme pdf` on the default configuration will generate the following:
2917
<img src="./images/example.png" alt="Example" width="50%" />
3018

31-
3219
### Configuration
3320

3421
`roundme` relies on a configuration file:
@@ -43,14 +30,8 @@ greater_than_one: ["c"] # optional
4330
- `less_than_one` is used for the `**` [rules](#rules) *(raw string comparison and sensible to space)*
4431
- `greater_than_one` is used for the `**` [rules](#rules) *(raw string comparison and sensible to space)*
4532

46-
4733
See the [balancer V2](./examples/balancer/README.md) example.
4834

49-
## Features
50-
- Recommend what arithemic operation needs to round up or down
51-
- Generate latex-based report in PDF
52-
53-
5435
## Rules
5536

5637
`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.
6243
- `A ** B`
6344
- `If A>=1 => rounding(A), rounding(B)`
6445
- `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)
46+
47+
## Install
48+
49+
Install with
50+
```bash
51+
cargo install roundme
52+
```
53+
54+
To install the latest GitHub version
55+
```bash
56+
git clone [email protected]:crytic/roundme.git
57+
cd roundme
58+
cargo install --path .
59+
```

0 commit comments

Comments
 (0)