Skip to content

Commit 7aff5a3

Browse files
committed
docs: relative links in README
1 parent b8583d4 commit 7aff5a3

File tree

1 file changed

+8
-10
lines changed

1 file changed

+8
-10
lines changed

README.md

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# PRBMath [![GitHub Actions][gha-badge]][gha] [![Foundry][foundry-badge]][foundry] [![License: MIT][license-badge]][license]
22

3-
[gha]: https://github.com/PaulRBerg/prb-math/actions
4-
[gha-badge]: https://github.com/PaulRBerg/prb-math/actions/workflows/ci.yml/badge.svg
3+
[gha]: ../../actions
4+
[gha-badge]: ../../actions/workflows/ci.yml/badge.svg
55
[foundry]: https://getfoundry.sh/
66
[foundry-badge]: https://img.shields.io/badge/Built%20with-Foundry-FFDB1C.svg
77
[license]: https://opensource.org/licenses/MIT
@@ -304,13 +304,12 @@ and `sqrt`.
304304
The main reason why PRBMath lags behind ABDKMath's `mul` and `div` functions is that it operates with 256-bit word sizes, and so it has to account for
305305
possible intermediary overflow. ABDKMath, on the other hand, operates with 128-bit word sizes.
306306

307-
**Note**: I did not find a good way to automatically generate gas reports for PRBMath. See the
308-
[#134](https://github.com/PaulRBerg/prb-math/discussions/134) discussion for more details about this issue.
307+
**Note**: I did not find a good way to automatically generate gas reports for PRBMath. See the [#134](../../discussions/134) discussion for more
308+
details about this issue.
309309

310310
### PRBMath
311311

312-
Gas estimations based on the [v2.0.1](https://github.com/PaulRBerg/prb-math/releases/tag/v2.0.1) and the
313-
[v3.0.0](https://github.com/PaulRBerg/prb-math/releases/tag/v3.0.0) releases.
312+
Gas estimations based on the [v2.0.1](../../releases/tag/v2.0.1) and the [v3.0.0](../../releases/tag/v3.0.0) releases.
314313

315314
| SD59x18 | Min | Max | Avg | | UD60x18 | Min | Max | Avg |
316315
| ------- | --- | ----- | ---- | --- | ------- | ---- | ----- | ---- |
@@ -353,8 +352,7 @@ Gas estimations based on the v3.0 release of ABDKMath. See my [abdk-gas-estimati
353352

354353
## Contributing
355354

356-
Feel free to dive in! [Open](https://github.com/PaulRBerg/prb-math/issues/new) an issue,
357-
[start](https://github.com/PaulRBerg/prb-math/discussions/new) a discussion or submit a PR.
355+
Feel free to dive in! [Open](../../issues/new) an issue, [start](../../discussions/new) a discussion or submit a PR.
358356

359357
### Pre Requisites
360358

@@ -369,10 +367,10 @@ In addition, familiarity with [Solidity](https://soliditylang.org/) is requisite
369367

370368
### Set Up
371369

372-
Clone this repository including submodules:
370+
Clone this repository:
373371

374372
```sh
375-
$ git clone --recurse-submodules -j8 [email protected]:PaulRBerg/prb-math.git
373+
$ git clone [email protected]:PaulRBerg/prb-math.git
376374
```
377375

378376
Then, inside the project's directory, run this to install the Node.js dependencies:

0 commit comments

Comments
 (0)