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

Documentation: fix readme linting errors #36

Merged
merged 1 commit into from
Aug 1, 2021
Merged

Documentation: fix readme linting errors #36

merged 1 commit into from
Aug 1, 2021

Conversation

qdm12
Copy link
Contributor

@qdm12 qdm12 commented Jul 31, 2021

Linted with Vscode's davidanson.vscode-markdownlint (based on https://github.com/DavidAnson/markdownlint)

  • Use consistent bullet points * instead of mixed * and -
  • Insert new lines where appropriate
  • Use consistent heading levels
  • Put title at top of readme before badges
  • Add language sh (shell) for syntax highlighting of code blocks

This blocks 2 PRs I want to do:

  • add an amd64 Docker (itself blocking a cross cpu docker) with instructions in readme
  • complete/update documentation for setup on Debian systems

@qdm12 qdm12 mentioned this pull request Jul 31, 2021
24 tasks
@Bubka Bubka merged commit ba676f7 into Bubka:master Aug 1, 2021
@lurendrejer lurendrejer mentioned this pull request Dec 12, 2024
1 task
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