Skip to content

Commit 192332e

Browse files
authored
Update README.md (#10725)
1 parent eefb8a0 commit 192332e

File tree

1 file changed

+17
-22
lines changed

1 file changed

+17
-22
lines changed

README.md

Lines changed: 17 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@
1313
[tg-support-badge]: https://img.shields.io/endpoint?color=neon&logo=telegram&label=support&style=flat-square&url=https%3A%2F%2Ftg.sumanjay.workers.dev%2Ffoundry_support
1414
[tg-support-url]: https://t.me/foundry_support
1515

16-
**[Install](https://book.getfoundry.sh/getting-started/installation)**
17-
| [User Book][foundry-book]
18-
| [Developer Docs](./docs/dev/README.md)
16+
**[Install](https://getfoundry.sh/getting-started/installation)**
17+
| [Docs][foundry-docs]
18+
| [Developer Guidelines](./docs/dev/README.md)
1919
| [Contributing](./CONTRIBUTING.md)
2020

2121
</div>
@@ -31,7 +31,7 @@ Foundry consists of:
3131
- [**Anvil**](#anvil): Fast local Ethereum development node, akin to Hardhat Network, Tenderly.
3232
- [**Chisel**](#chisel): Fast, utilitarian, and verbose Solidity REPL.
3333

34-
**Need help getting started with Foundry? Read the [📖 Foundry Book][foundry-book]!**
34+
**Need help getting started with Foundry? Read the [📖 Foundry Docs][foundry-docs]!**
3535

3636
![Demo](.github/assets/demo.gif)
3737

@@ -82,9 +82,9 @@ foundryup
8282

8383
**Done!**
8484

85-
For additional details see the [installation guide](https://book.getfoundry.sh/getting-started/installation) in the [Foundry Book][foundry-book].
85+
For additional details see the [installation guide](https://getfoundry.sh/getting-started/installation) in the [Foundry Docs][foundry-docs].
8686

87-
If you're experiencing any issues while installing, check out [Getting Help](#getting-help) and the [FAQ](https://book.getfoundry.sh/faq).
87+
If you're experiencing any issues while installing, check out [Getting Help](#getting-help) and the [FAQ](https://getfoundry.sh/faq).
8888

8989
## How Fast?
9090

@@ -151,7 +151,7 @@ forge build
151151
Compiler run successful!
152152
```
153153

154-
Let's [test](https://book.getfoundry.sh/forge/tests#tests) our contracts:
154+
Let's [test](https://getfoundry.sh/forge/tests#tests) our contracts:
155155

156156
```sh
157157
forge test
@@ -186,7 +186,7 @@ If you wish to simulate on-chain transactions pass a RPC URL.
186186

187187
Run `forge --help` to explore the full list of available subcommands and their usage.
188188

189-
More documentation can be found in the [forge][foundry-book-forge] section of the Foundry Book.
189+
More documentation can be found in the [forge](https://getfoundry.sh/forge/overview) section of the Foundry Docs.
190190

191191
## Cast
192192

@@ -218,7 +218,7 @@ Optionally, pass `--etherscan-api-key <API_KEY>` to decode transaction traces us
218218

219219
Run `cast --help` to explore the full list of available subcommands and their usage.
220220

221-
More documentation can be found in the [cast][foundry-book-cast] section of the Foundry Book.
221+
More documentation can be found in the [cast](https://getfoundry.sh/cast/overview) section of the Foundry Docs.
222222

223223
## Anvil
224224

@@ -240,7 +240,7 @@ cast block-number
240240

241241
Run `anvil --help` to explore the full list of available features and their usage.
242242

243-
More documentation can be found in the [anvil][foundry-book-anvil] section of the Foundry Book.
243+
More documentation can be found in the [anvil](https://getfoundry.sh/anvil/overview) section of the Foundry Docs.
244244

245245
## Chisel
246246

@@ -287,7 +287,7 @@ contract REPL {
287287

288288
Run `chisel --help` to explore the full list of available features and their usage.
289289

290-
More documentation can be found in the [chisel][foundry-book-chisel] section of the Foundry Book.
290+
More documentation can be found in the [chisel](https://getfoundry.sh/chisel/overview) section of the Foundry Docs.
291291

292292
## Configuration
293293

@@ -302,9 +302,9 @@ Foundry is highly configurable, allowing you to tailor it to your needs. Configu
302302

303303
---
304304

305-
You can find additional [setup and configurations guides][foundry-book-config] in the [Foundry Book][foundry-book] and in the [config crate](./crates/config/README.md):
305+
You can find additional [setup and configurations guides](https://getfoundry.sh/config/overview) in the [Foundry Docs][foundry-docs] and in the [config crate](./crates/config/README.md):
306306

307-
- [Configuring with `foundry.toml`](https://book.getfoundry.sh/config/)
307+
- [Configuring with `foundry.toml`](https://getfoundry.sh/config/overview)
308308
- [Setting up VSCode][vscode-setup]
309309
- [Shell autocompletions][shell-setup]
310310

@@ -314,7 +314,7 @@ See our [contributing guidelines](./CONTRIBUTING.md).
314314

315315
## Getting Help
316316

317-
First, see if the answer to your question can be found in the [Foundy Book][foundry-book], or in the relevant crate.
317+
First, see if the answer to your question can be found in the [Foundy Docs][foundry-docs], or in the relevant crate.
318318

319319
If the answer is not there:
320320

@@ -342,12 +342,7 @@ shall be dual licensed as above, without any additional terms or conditions.
342342
- All the other [contributors](https://github.com/foundry-rs/foundry/graphs/contributors) to the [ethers-rs](https://github.com/gakonst/ethers-rs), [alloy][alloy] & [foundry](https://github.com/foundry-rs/foundry) repositories and chatrooms.
343343

344344
[solidity]: https://soliditylang.org/
345-
[foundry-book]: https://book.getfoundry.sh
346-
[foundry-book-config]: https://book.getfoundry.sh/config/
347-
[foundry-book-forge]: https://book.getfoundry.sh/reference/forge/
348-
[foundry-book-anvil]: https://book.getfoundry.sh/reference/anvil/
349-
[foundry-book-cast]: https://book.getfoundry.sh/reference/cast/
350-
[foundry-book-chisel]: https://book.getfoundry.sh/reference/chisel/
345+
[foundry-docs]: https://getfoundry.sh
351346
[foundry-gha]: https://github.com/foundry-rs/foundry-toolchain
352347
[foundry-compilers]: https://github.com/foundry-rs/compilers
353348
[ethers-solc]: https://github.com/gakonst/ethers-rs/tree/master/ethers-solc/
@@ -359,8 +354,8 @@ shall be dual licensed as above, without any additional terms or conditions.
359354
[geb]: https://github.com/reflexer-labs/geb
360355
[benchmark-post]: https://www.paradigm.xyz/2022/03/foundry-02#blazing-fast-compilation--testing
361356
[convex]: https://github.com/mds1/convex-shutdown-simulation
362-
[vscode-setup]: https://book.getfoundry.sh/config/vscode.html
363-
[shell-setup]: https://book.getfoundry.sh/config/shell-autocompletion.html
357+
[vscode-setup]: https://getfoundry.sh/config/vscode.html
358+
[shell-setup]: https://getfoundry.sh/config/shell-autocompletion.html
364359
[foundry-0.2]: https://github.com/foundry-rs/foundry/releases/tag/nightly-5b7e4cb3c882b28f3c32ba580de27ce7381f415a
365360
[foundry-1.0]: https://github.com/foundry-rs/foundry/releases/tag/nightly-59f354c179f4e7f6d7292acb3d068815c79286d1
366361
[dapptools]: https://github.com/dapphub/dapptools

0 commit comments

Comments
 (0)