Update README.md #1304
Merged
Update README.md #1304
Conversation
This file contains hidden or 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
There was a problem hiding this comment.
Pull Request Overview
This PR updates the documentation in README.md by simplifying the development environment setup instructions.
- Removes detailed installation steps for various operating systems
- Replaces the previous instructions with a simple note to ensure npm is installed
Comments suppressed due to low confidence (1)
README.md:13
- The simplification greatly reduces detailed setup instructions which might be useful for developers using non-standard setups or different operating systems. Consider adding a note or a link to a more detailed guide if this less detailed instruction is insufficient for some environments.
Make sure you have `npm` installed.
sfc-gh-dmatthews
approved these changes
Jun 19, 2025
README.md
Outdated
|
|
||
| $ python -m venv venv | ||
| ``` | ||
| Make sure you have `npm` installed. |
There was a problem hiding this comment.
Suggested change
| Make sure you have `npm` installed. | |
| Make sure you have [`npm`](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) installed. |
Don't we also need people to install make? It comes along with the xcode-select --install command on Mac, I think.
|
I approved it, but I think we need to put a couple more details back in so the setup instructions are complete. |
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.
📚 Context
Just making sure our dev instructions are correct.
🧠 Description of Changes
Just making sure our dev instructions are correct.
💥 Impact
Size:
Contribution License Agreement
By submitting this pull request you agree that all contributions to this project are made under the Apache 2.0 license.