Create README.md in default template #5465
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Evalir
requested changes
Jul 25, 2023
cli/assets/README.md
Outdated
| @@ -0,0 +1,59 @@ | |||
| # Foundry | |||
|
|
|||
| Foundry is a smart contract development toolchain. | |||
There was a problem hiding this comment.
I'd expand this section to include what the repo readme says about the parts of foundry (forge, cast, anvil)
There was a problem hiding this comment.
Foundry is a blazing fast, portable and modular toolkit for Ethereum application development written in Rust.
Foundry consists of:
- Forge: Ethereum testing framework (like Truffle, Hardhat and DappTools).
- Cast: Swiss army knife for interacting with EVM smart contracts, sending transactions and getting chain data.
- Anvil: Local Ethereum node, akin to Ganache, Hardhat Network.
- Chisel: Fast, utilitarian, and verbose solidity REPL.
This is what I'm planning to add, let me know your thoughts.
cli/assets/README.md
Outdated
| ### Deploy | ||
|
|
||
| ```shell | ||
| $ forge create --rpc-url <your_rpc_url> --private-key <your_private_key> src/MyContract.sol:MyContract |
There was a problem hiding this comment.
I'd use forge script here instead of forge create.
There was a problem hiding this comment.
sure! I will change it to forge script
`Foundry` intro section is expanded the same as ReadMe in the Foundry repo. `forge create` is changed to `forge script`
|
I have made the suggested changes. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adding README.md in the default template to give more info on how to work with the provided template.
fixes #5456