chore: Update README #1261
Merged
chore: Update README #1261
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
ghaith
reviewed
Jul 16, 2024
README.md
Outdated
| Generating LLVM IR is accomplished with the help of [_inkwell_](https://github.com/TheDan64/inkwell), a Rust-wrapper around the native LLVM C-API. | ||
| Generating LLVM IR is accomplished with the help of [_inkwell_](https://github.com/TheDan64/inkwell), a Rust-wrapper around the native LLVM C-API. --> | ||
|
|
||
| <!-- This seems to be broken? |
There was a problem hiding this comment.
tokei breaks often, but it also works enough times..
Why are the other ones disabled?
There was a problem hiding this comment.
Except for the tokei and codecov badge they felt redundant since the last commit on the master branch already provides GitHub actions information. Do you want me to re-enable them?
There was a problem hiding this comment.
I thought it would be a quick way to get to the latest build so that you can download it.. but we should probably do this differently. Maybe integrate them in the text somewhere
There was a problem hiding this comment.
ghaith
approved these changes
Jul 29, 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.
I've taken some inspiration from other popular open-source projects, moving the most important links to the beginning of the README and stripping it down a bit in the process. This should make reading the README more "pleasant". The rendered version can be found here (which to be fair looks very minimalistic). I'm not sure if we're a fan of this, but I thought I'd open a PR.