Skip to content

chore: improved readme #1405

Closed
AncientPatata wants to merge 1 commit intomainfrom
ad/armonik-readme
Closed

chore: improved readme #1405
AncientPatata wants to merge 1 commit intomainfrom
ad/armonik-readme

Conversation

@AncientPatata
Copy link
Copy Markdown
Contributor

Motivation

[Include the reason behind these changes and any relevant context.]

Description

  • Yes, there are multiple PRs for this task, we wanted to use PRs to be able to comment on specific sections and whatnot.
  • I think banners for section titles add more color and life to the README.md, I couldn't control much else (padding/margins/etc.), ideally in the final one we could have little stylistic figures to illustrate the various features and what not.

Testing

[When applicable, detail the testing you have performed to ensure that these changes function as intended. Include information about any added tests.]

Impact

[Discuss the impact of your modifications on ArmoniK. This might include effects on performance, configuration, documentation, new dependencies, or changes in behaviour.]

Additional Information

[Any additional information that reviewers should be aware of.]

Checklist

  • My code adheres to the coding and style guidelines of the project.
  • I have performed a self-review of my code.
  • I have commented my code, particularly in hard-to-understand areas.
  • I have made corresponding changes to the documentation.
  • I have thoroughly tested my modifications and added tests when necessary.
  • Tests pass locally and in the CI.
  • I have assessed the performance impact of my modifications.

@sonarqubecloud
Copy link
Copy Markdown

@AncientPatata
Copy link
Copy Markdown
Contributor Author

Closed in favor of the main PR

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.

1 participant