obs-studio icon indicating copy to clipboard operation
obs-studio copied to clipboard

Update Readme.rst

Open Ishaan2053 opened this issue 2 years ago • 3 comments

Description

Updated the repository's readme.rst file and added the following changes:

  • Added alt. text to all links
  • Added OBS logo at the top
  • Polished the document's appearance
  • Rephrased some text

Motivation and Context

  • The readme file on the repo's main page required an overhaul. This PR improves the documentation for easier readability, improved appearance and better comprehension by beginners and advanced users alike.

How Has This Been Tested?

  • NA

Types of changes

  • Documentation

Checklist:

  • [ ] My code has been run through clang-format.
  • [x] I have read the contributing document.
  • [x] My code is not on the master branch.
  • [ ] The code has been tested.
  • [x] All commit messages are properly formatted and commits squashed where appropriate.
  • [x] I have included updates to all appropriate documentation.

Ishaan2053 avatar Jan 23 '23 11:01 Ishaan2053

We have historically rejected third party attempts to simply "prettify" our readme, but this is the closest to an actual cleanup and improvement I've seen to far. Please squash your commits, and update the commit to follow our commit guidelines.

Fenrirthviti avatar Jan 31 '23 18:01 Fenrirthviti

I sure can squash the commits into one. However, I have a question: Maybe this PR can be closed, and the commits can be squashed on your end? (something like the attached screenshot).

image

Ishaan2053 avatar Feb 01 '23 17:02 Ishaan2053

I would prefer if you were to make the corrections if you want this to be accepted, especially given the fact that you have checked the box stating you read our guidelines, and that your commits were squashed and formatted correctly, when they were not. If you are unsure how to squash commits, there are plenty of resources available that can show you how.

Fenrirthviti avatar Feb 01 '23 17:02 Fenrirthviti

As this has not been updated per request, closing.

Fenrirthviti avatar Feb 15 '23 18:02 Fenrirthviti