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

chore: adjust readme.md for beginners #71

Merged
merged 11 commits into from
Jun 21, 2024

Conversation

olivierhalupczok
Copy link
Collaborator

@olivierhalupczok olivierhalupczok commented Jun 19, 2024

Signed-off-by: Olivier Halupczok [email protected]

PR Type

What kind of change does this PR introduce?

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • CI related changes
  • Documentation content changes
  • Other... Please describe:

What is the current behavior?

Current Readme.md file was shorter and was mainly aimed for more advanced users.

Issue Number: N/A

What is the new behavior?

N/A - Only changes to the Readme.md file, so it is easier to understand for beginners.

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

Signed-off-by: Olivier Halupczok <[email protected]>
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@olivierhalupczok olivierhalupczok marked this pull request as draft June 20, 2024 09:57
@olivierhalupczok olivierhalupczok marked this pull request as ready for review June 21, 2024 09:11
@olivierhalupczok olivierhalupczok force-pushed the chore/adjust-readme-for-easier-understanding branch from 68a0863 to c9270f4 Compare June 21, 2024 09:26
@sebastianmusial sebastianmusial merged commit 8ee6058 into main Jun 21, 2024
1 check passed
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.

None yet

2 participants