Improve accessibility, ease of use, and standard conformance, in the README.
#3397
+70
−35
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
- Each line actually has a `\n`, to adhere to CommonMark.
This remediates inconsistent `line-height`s, and ensures that `br`s are replaced with `p`s, for WHATWG HTML LS conformance (and, thereby, WCAG AA).
- Values, and their measures, conform to ISO 31-0.
- Electronic values utilise IEC {60027-2 / 80000-13} / IEEE 1541-2002.
- Erroneously absent commas and periods have been appended where relevant.
- Quotation style has been made consistent; previously, double and single were utilised interchangeably, in the same sentence.
- Some characters were replaced with semantic UTF counterparts:
Original | Replacement
---------|------------
~ | ≈
... | …
- “`<IDEA_HOME>`” was replaced with “`$HOME`”, because it exists by default on Windows's (via PowerShell), and every Linux OS (via `bash`/`sh`).
This means that users don't need to ascertain what their `$HOME` path is.
RokeJulianLockhart
changed the title
README.README.
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.
Each line actually has a
\n, to adhere to CommonMark.This remediates inconsistent
line-heights, and ensures thatbrs are replaced withps, for WHATWG HTML LS conformance (and, thereby, WCAG AA).Values, and their measures, conform to ISO 31-0.
Electronic values utilise IEC {60027-2 / 80000-13} / IEEE 1541-2002.
Erroneously absent commas and periods have been appended where relevant.
Quotation style has been made consistent; previously, double and single were utilised interchangeably, in the same sentence.
Some characters were replaced with semantic UTF counterparts:
“
<IDEA_HOME>” was replaced with “$HOME”, because it exists by default on Windows's (via PowerShell), and every Linux OS (viabash/sh).This means that users don't need to ascertain what their
$HOMEpath is.