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

Adapt readme and contributing guide to create-eth repo #26

Merged
merged 3 commits into from
May 7, 2024

Conversation

Pabl0cks
Copy link
Collaborator

@Pabl0cks Pabl0cks commented May 6, 2024

Initial tweaks to adapt old SE-2 Readme and Contributing guide to new create-eth repo.

Maybe I deleted too much stuff in Readme for a initial iteration, we can get back basic SE-2 screenshot and features from initial part of the Readme if you prefer 🙌

Fixes #10

@Pabl0cks Pabl0cks changed the title Adapt readme to create-eth repo Adapt readme and contributing guide to create-eth repo May 6, 2024
CONTRIBUTING.md Show resolved Hide resolved
@rin-st
Copy link
Member

rin-st commented May 6, 2024

Lgtm!

README.md Show resolved Hide resolved
Copy link
Member

@carletex carletex left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks great @Pabl0cks Thank you!

left a comment in case you guys see it interesting to add.

Copy link
Collaborator

@technophile-04 technophile-04 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tysm @Pabl0cks, looking great !

One thing I would like to mention maybe not in this PR and maybe after #25 is after point 1. in qucikstart after foundry hint maybe we could mention that checkout generated README for more details on getting started / commands (maybe we could also mention this at end)

^ But yeah lol it might be not needed since after #25 we will be already mentioning this at the end in CLI output 🙌

@Pabl0cks
Copy link
Collaborator Author

Pabl0cks commented May 6, 2024

One thing I would like to mention maybe not in this PR and maybe after #25 is after point 1. in qucikstart after foundry hint maybe we could mention that checkout generated README for more details on getting started / commands (maybe we could also mention this at end)

Yep, nice idea! 🙌

Not sure where the best place would be. What about in Documentation section (maybe the name of the section could be tweaked a bit), and the content could be something like this:

  • Check out the README.md generated in your instance folder for more details about getting started / commands.
  • Visit our docs to learn how to start building with Scaffold-ETH 2.
  • To know more about SE-2 features, check out our website.

Not so sure about the location, just thinking out loud!

Copy link
Member

@carletex carletex left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is a great starting point!

Thank you all!

@carletex carletex merged commit a93a09b into main May 7, 2024
@carletex carletex deleted the update/readme-first-iteration branch May 7, 2024 08:35
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.

Update README
4 participants