README: describe how to run the tests #1981
Merged
Conversation
This file contains 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
The `ShellSession` markup seems to be relatively uncommon, only supported on GitHub. A more common markup -- also understood by GitHub, but supported much more widely, e.g. in Hugo's very own default Markdown processor -- is the `console` one. So let's use that instead. Signed-off-by: Johannes Schindelin <[email protected]>
As early as 5d721a7 (readme is markdown, 2012-03-08), the `README` was written in Markdown, but its Unix shell command snippets were not marked up as such (most likely because way back when, syntax highlighting in `<pre>` blocks had not yet been dreamt up). However, we are approaching the end of the first quarter of the 21st century and it is time to go with the times. Signed-off-by: Johannes Schindelin <[email protected]>
I had already provided links, a long time ago, but failed to jot down notes that were so far stuck in my brain but would most likely benefit new contributors a lot. Signed-off-by: Johannes Schindelin <[email protected]>
TheGiraffe3
reviewed
Mar 17, 2025
Co-authored-by: Loymdayddaud <[email protected]>
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.
Changes
Context
I've been meaning to add this for a while, as it's a common question from new contributors. And today, I found myself wanting the steps explained in the README, as I needed to run the tests, hadn't run them in a while, and had forgotten how to do that.