readme: updates again #29
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
Moves some things around to move usage up and development down a bit. Signed-off-by: Simon de Vlieger <[email protected]>
Include our default project information blurb in the README. Signed-off-by: Simon de Vlieger <[email protected]>
Moves the `test` to `lint`, moves the link into a prettier one. Signed-off-by: Simon de Vlieger <[email protected]>
|
Last commit needs #28 to be merged to make sense. |
schuellerf
requested changes
Apr 23, 2024
README.md
Outdated
| repository including all the tests with: | ||
|
|
||
| ``` | ||
| make test | ||
| make lint |
There was a problem hiding this comment.
"including all the tests" is not really true after this change
There was a problem hiding this comment.
Changed it back to make test which now includes pre-commit again as per #28.
Use `make test` which includes `pre-commit` to conform with the text above it. Signed-off-by: Simon de Vlieger <[email protected]>
schuellerf
approved these changes
Apr 23, 2024
achilleas-k
approved these changes
Apr 23, 2024
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.
Some minor updates to the readme to re-order, make the pre-commit link a bit prettier, and to include our generic project blurb.