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

Review and update README.md #1012

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
Open

Review and update README.md #1012

wants to merge 8 commits into from

Conversation

DavidBiddle
Copy link
Contributor

@DavidBiddle DavidBiddle commented Mar 4, 2025

Reviews and updates the repo README.md file.

The biggest change is removing the Apple Silicon specific guidance - I don't think we need this any more. The rest is mostly minor cosmetic things (typos, broken links, formatting). See individual commit messages for details.

Fixes #1007 (thanks to external contributor @ceri for raising #984, which triggered this review)

I recently set up the GDS Way locally on a new GDS developer Macbook and
didn't have to do this. I can't see any recommendation to do this on the
Eventmachine github repo either, so I assume this issue is resolved now.

Let's remove it fo now, and if people have trouble setting it the
project up in future we can readd it.
Specifying the language in code blocks will give us some syntax
highlighting in Github.

I went with zsh because it's the default Mac terminal, the end result is
unlikely to be significantly different to bash.
Makes the link text more descriptive, so that it makes sense when read
in other contexts (e.g. a screen reader's list of links).
I just think they're neat!
Some lines were being rewrapped around column 80, some weren't, so this
commit rewraps them all for consistency.
@DavidBiddle DavidBiddle linked an issue Mar 4, 2025 that may be closed by this pull request
@DavidBiddle DavidBiddle changed the title Update readme Review and update README.md Mar 4, 2025
@DavidBiddle DavidBiddle marked this pull request as ready for review March 4, 2025 15:00
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.

Review and update README Requirement for openssl@1.1 needs to be updated
1 participant