Revise README for improved project documentation #33
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
Updated README to enhance clarity and detail about setup and usage.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Hi, I'm Yash. I'm exploring the DataLoom project as part of preparing a GSoC proposal and while setting it up locally I noticed that the setup instructions were outdated and didn't match the current monorepo/Turborepo workflow.
This PR updates the README to include:
npm installandnpm run devworkflow from the project rootThis reflects how the project currently works and should make onboarding easier for new contributors.
If any section should be modified, shortened, or reverted, I'm happy to adjust.