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

Revise README #5728

Merged
merged 2 commits into from
May 23, 2023
Merged

Revise README #5728

merged 2 commits into from
May 23, 2023

Conversation

rubo
Copy link
Contributor

@rubo rubo commented May 23, 2023

Changes

  • Updated and revised installation instructions
  • Moved prerequisite requirements to the "Download and run" section to make it more visible
  • Added Visual C++ Redistributable requirement
  • Revised the security policy wording

Types of changes

What types of changes does your code introduce?

  • Bugfix (a non-breaking change that fixes an issue)
  • New feature (a non-breaking change that adds functionality)
  • Breaking change (a change that causes existing functionality not to work as expected)
  • Optimization
  • Refactoring
  • Documentation update
  • Build-related changes
  • Other: Description

Testing

Requires testing

  • Yes
  • No

Remarks

The Linux requirements have been tested with recent distros.

@rubo rubo requested review from flcl42 and kamilchodola May 23, 2023 17:25
@rubo rubo added the docs label May 23, 2023
@rubo rubo marked this pull request as ready for review May 23, 2023 17:29
@rubo rubo requested a review from benaadams May 23, 2023 17:34
@rubo rubo merged commit c379b71 into master May 23, 2023
@rubo rubo deleted the feature/readme-revised branch May 23, 2023 20:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@benaadams benaadams benaadams approved these changes

@flcl42 flcl42 Awaiting requested review from flcl42

@kamilchodola kamilchodola Awaiting requested review from kamilchodola

@LukaszRozmej LukaszRozmej Awaiting requested review from LukaszRozmej LukaszRozmej is a code owner

@MarekM25 MarekM25 Awaiting requested review from MarekM25 MarekM25 is a code owner

Assignees
No one assigned
Labels
docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@rubo @benaadams