Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create specific README files for foundry and hardhat options #782

Merged
merged 6 commits into from
Mar 23, 2024

Conversation

Pabl0cks
Copy link
Collaborator

Description

Delete base template README and create 2 different README files, with the specific commands and file routes for Hardhat or Foundry. Add each file to their corresponding template folder.

Additional Information

Related Issues

Closes #755

Your ENS/address: pabl0cks.eth

@rin-st
Copy link
Collaborator

rin-st commented Mar 22, 2024

Works great! Thanks @Pabl0cks !

@technophile-04
Copy link
Collaborator

Maybe the common parts between both READMEs can be in another file, and when the extension is installed, the README is merged.

But not sure it's easy to do with .md files and with multiple params

Just templated the READEME's because if you choose "none" for "What solidity framework do you
want to use?" option you were not getting any README (lol but I agree that "none" option mostly no one uses)

For now templated the whole QuickStart section because it had differences based on option's selected.

Also if anyone want's to test quickly you could select no for install dependencies and copy changes from #784

@rin-st
Copy link
Collaborator

rin-st commented Mar 22, 2024

Just templated the READEME's because if you choose "none" for "What solidity framework do you
want to use?" option you were not getting any README (lol but I agree that "none" option mostly no one uses)

Great!

For now templated the whole QuickStart section because it had differences based on option's selected.

Noticed that half of quick start still copypasted. Maybe divide it to smaller but specific templates, like runLocalNetworkDescription, deployContract and runTests?

Also if anyone want's to test quickly you could select no for install dependencies and copy changes from #784

Works 👍

@technophile-04
Copy link
Collaborator

Maybe divide it to smaller but specific templates, like runLocalNetworkDescription, deployContract and runTests?

Ohh yes! I had the same thought but when we add more plugins like the subgraph etc I thought maybe its better to templatise the whole quickstart section.

But yeah 100% agree that we could make it more granular 🙌 For this PR keeping it as it but in future we should update it

Thanks all ! Mering this 🙌

@technophile-04 technophile-04 merged commit 8984d74 into cli Mar 23, 2024
@technophile-04 technophile-04 deleted the cli-readme-hardhat-foundry branch March 23, 2024 15:34
@Pabl0cks
Copy link
Collaborator Author

Thanks for the reviews! ♥ Nice catch and great improvements @technophile-04 🙌

@rin-st rin-st mentioned this pull request Mar 27, 2024
2 tasks
@github-actions github-actions bot mentioned this pull request Apr 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants