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

docs: Move Developing bun from README.md to CONTRIBUTING.md #1126

Closed
wants to merge 1 commit into from

Conversation

mljlynch
Copy link
Contributor

I was trying to build bun for the first time and it was confusing to me where to start.

Per #798 - I think this would be helpful to getting more people started.

A few other TODOs:

  • There is not a clear list of system requirements - per the section Troubleshooting (general) at the bottom it appears that 22 GB of RAM is necessary to compile. It may be helpful to add that to a doc like this.
  • It may be helpful to have an overview of how the code is structured and some description of the submodules.

@github-actions github-actions bot added the chore Task to improve the repository label Aug 22, 2022
@mljlynch mljlynch changed the title docs: Move developing bun from README.md to CONTRIBUTING.md docs: Move Developing bun from README.md to CONTRIBUTING.md Aug 22, 2022
@Jarred-Sumner
Copy link
Collaborator

Thanks for this

IMO, a single long readme designed for CMD + F is better

I think separate pages work better for websites than for markdown files on github

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chore Task to improve the repository
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants