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

chore: expand init instructions, clean after init #235

Merged
merged 1 commit into from
May 10, 2023

Conversation

markdalgleish
Copy link
Member

This change was motivated by some upcoming work in create-remix but this is still a useful change in the meantime that can go out immediately.

From an end user perspective, if the remix.init script runs during the create-remix flow, the npx remix init instructions are no longer present in the readme since they're redundant and just add noise.

For those that didn't already run the remix.init script (either because they opted out of installing dependencies, or because they cloned this repo directly), the instructions are now much clearer since they're not conditional — you don't have to remember whether or not you opted out of installing dependencies anymore. We also now make it clear that this script makes changes to your project that are intended to be committed.

```

- Initial setup: _If you just generated this project, this step has been done for you._
Copy link
Member Author

Choose a reason for hiding this comment

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

This line isn't conditional in blues-stack, and there's actually no harm in running this script again. Since literally every contributor going forwards need to run this script, I think it's cleaner to leave it as just Initial setup:

@markdalgleish markdalgleish merged commit 3e7c15e into main May 10, 2023
@markdalgleish markdalgleish deleted the markdalgleish/readme-init-cleanup branch May 11, 2023 03:22
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.

2 participants