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.

Sign up for GitHub

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

Jump to bottom

Improve README formatting #15

Closed
wants to merge 1 commit into from
Closed

Improve README formatting #15

wants to merge 1 commit into from
+32 −32

Conversation

Marcono1234
Copy link
Contributor

Tries to improve the README formatting by:

  • Changing steps to numbered list
  • Indenting code blocks of list points to not disrupt reading flow:
    Before After

Please let me know if you want anything changed or some of the changes reverted.

@aronwk-aaron
Copy link
Member

Seems Unnecessary

@Marcono1234
Copy link
Contributor Author

Do you mind explaining a bit more in detail what of this seems unnecessary?
Aren't those steps which need to be executed in a specific order, and therefore numbering makes sense; and aren't the code blocks specific to some step and should therefore be part of that step?

@Marcono1234 Marcono1234 deleted the README-formatting branch March 24, 2024 18:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@Marcono1234 @aronwk-aaron