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

README: Use GitHub Actions badge instead of dysfunct Travis #81

Merged
merged 1 commit into from
Oct 5, 2024

Conversation

MarijnS95
Copy link
Collaborator

@MarijnS95 MarijnS95 commented Nov 12, 2023

Seems the last successful build there was 2 years ago, and the badge now says "Build: No longer available". Switch the badge over to reflect the CI status on GitHub Actions instead.

Note that there is unfortunately no for-the-badge style available here to match the other badges, which we should perhaps update to match GitHub's style instead?

Also add a badge linking to the documentation of the main v4l crate, wrap some crate names in backticks, and format the markdown documents to have proper spacing around headings.

@raymanfx
Copy link
Owner

I‘m fine with changing the badge style. You put in more work than I did lately, so I think it’s fair to leave it up to you to choose.

Feel free to change the other ones as well.

@MarijnS95 MarijnS95 force-pushed the marijn/readme-gh-actions-ci-badge branch from 6608fca to 32f6dc4 Compare November 19, 2023 21:05
Seems the last successful build there was 2 years ago, and the badge now
says "Build: No longer available".  Switch the badge over to reflect the
CI status on GitHub Actions instead.

Also add a badge linking to the documentation of the main `v4l` crate,
wrap some crate names in backticks, and format the markdown documents
to have proper spacing around headings.
@MarijnS95 MarijnS95 force-pushed the marijn/readme-gh-actions-ci-badge branch from 32f6dc4 to 0587c8b Compare November 19, 2023 21:06
@MarijnS95
Copy link
Collaborator Author

MarijnS95 commented Nov 19, 2023

Done, plus some other cleanups.

Future work:

Copy link
Owner

@raymanfx raymanfx left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a reason for all these newlines between header and content? I don't care too much to really object, but I'm curious what your motivation is.

@MarijnS95
Copy link
Collaborator Author

I ran one of the random autoformatters over this document while editing (by accident) and quite like the empty lines it added around headings. I can revert it if it makes things too verbose though, but it shouldn't have any effect on the rendered output.

@raymanfx
Copy link
Owner

I'm not opposed to changing the formatting, but in that case we need to at least document the process, settle on a linter all of us use etc. Could you add a small section outlining the steps to run the linter?

@MarijnS95
Copy link
Collaborator Author

I think I'll just revert it in that case. I don't want to have strict (CI) processes and linting for two odd markdown files, when it only is the # heading that look off when they are crammed together with the text. Same for the README where there's some unneeded space before * and a crate name not in backticks, that not something to document IMO.

@raymanfx raymanfx merged commit 566e08a into master Oct 5, 2024
10 checks passed
@raymanfx
Copy link
Owner

raymanfx commented Oct 5, 2024

I figured there's no point in endless bike shedding when I hardly have the time for proper review and possibly modification of the changes anyway. Let's just get the good stuff in and improve them down the line as required.

@MarijnS95 MarijnS95 deleted the marijn/readme-gh-actions-ci-badge branch October 5, 2024 18:39
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.

2 participants