Merge pull request #979 from Yashraj347/fix-docs

docs: improve README, license formatting, and contribution guide

Author: dericed

CONTRIBUTING.md

@@ -1,28 +1,30 @@
 # Contribution Guide
 
-## Rules for contributing
+## Rules for Contributing
 
-This project welcomes contributions and feedback. Open source feedback and participation of all kinds and from any interested party or institution is encouraged and can be made through opening an issue or pull request on GitHub.
+This project welcomes contributions and feedback. Open-source feedback and participation of all kinds, from any interested party or institution, are encouraged and can be made by opening an issue or submitting a pull request on GitHub.
 
-## How to contribute
+## How to Contribute
 
-The maintainers of this repository welcome feedback, questions, criticism and contributions. There are several ways to participate:
+The maintainers of this repository welcome feedback, questions, criticism, and contributions. There are several ways to participate:
 
 ### Add or Comment on Issues
 
-Anyone is welcome to start a new issue by selecting the `Issues` tab in GitHub and clicking [New Issue](https://github.com/amiaopensource/vrecord/issues/new).
+Anyone is welcome to start a new issue by selecting the `Issues` tab on GitHub and clicking [New Issue](https://github.com/amiaopensource/vrecord/issues/new).
 
-All existing issues, open and closed, may be reviewed or commented upon in the [Issues](https://github.com/amiaopensource/vrecord/issues?utf8=%E2%9C%93&q=is%3Aissue) section.
+All existing issues, both open and closed, may be reviewed or commented on in the [Issues](https://github.com/amiaopensource/vrecord/issues?utf8=%E2%9C%93&q=is%3Aissue) section.
 
-### Reviewing Comments
+### Reviewing Commits
 
-The recent work on this repository can be reviewed in the [Commit Log](https://github.com/amiaopensource/vrecord/commits/master). Clicking on an issue will show a summary of what was added, removed, or changed. Any commit may be commented upon to request further clarification, propose a suggestion, offer support, or suggest an alternate approach.
+Recent work on this repository can be reviewed in the [Commit Log](https://github.com/amiaopensource/vrecord/commits/master). Clicking on a commit will show a summary of what was added, removed, or changed. Any commit may be commented on to request further clarification, propose a suggestion, offer support, or suggest an alternative approach.
 
 ### Pull Requests
 
-Pull requests are proposals to apply changes to the repository which could include adding or editing existing documentation, adding images, or providing or changing content. There are several guides that document how to contribute to GitHub repositories such as:
+Pull requests are proposals to apply changes to the repository. These could include adding or editing existing documentation, adding images, or modifying content.
+
+There are several guides that explain how to contribute to GitHub repositories, such as:
 
 - https://guides.github.com/activities/contributing-to-open-source/
 - https://www.thinkful.com/learn/github-pull-request-tutorial/
 
-If you'd like to contribute to the repository but are unsure how to do this, please feel welcome to contact the project maintainers.
+If you'd like to contribute to the repository but are unsure how to do so, please feel free to contact the project maintainers.

LICENSE.txt

@@ -33,7 +33,7 @@ exhaustive, and do not form part of our licenses.
      material not subject to the license. This includes other CC-
      licensed material, or material used under an exception or
      limitation to copyright. More considerations for licensors:
-    wiki.creativecommons.org/Considerations_for_licensors
+     wiki.creativecommons.org/Considerations_for_licensors
 
      Considerations for the public: By using one of our public
      licenses, a licensor grants the public permission to use the
@@ -50,7 +50,7 @@ exhaustive, and do not form part of our licenses.
      Although not required by our licenses, you are encouraged to
      respect those requests where reasonable. More considerations
      for the public:
-    wiki.creativecommons.org/Considerations_for_licensees
+     wiki.creativecommons.org/Considerations_for_licensees
 
 =======================================================================
 

README.md

@@ -37,14 +37,14 @@ This documentation is up to date as of vrecord version 2020-02-10.
 
 ## Summary
 
-Vrecord is open-source software for capturing a video signal and turning it into a digital file. Its purpose is to make videotape digitization or transfer easier. Vrecord can capture analog and digital signals through a variety of inputs and can create digital video files in a variety of formats and codecs. Vrecord has been designed with needs of audiovisual archivists in mind. 
+Vrecord is open-source software for capturing a video signal and turning it into a digital file. Its purpose is to make videotape digitization or transfer easier. Vrecord can capture analog and digital signals through a variety of inputs and can create digital video files in a variety of formats and codecs. Vrecord has been designed with the needs of audiovisual archivists in mind. 
 
-Vrecord uses MediaArea’s [ffmpeg-ma](https://github.com/MediaArea/homebrew-mediaarea/blob/master/ffmpeg-ma.rb) to do its dirty work. Other dependencies are: cowsay, [decklinksdk](https://github.com/amiaopensource/homebrew-amiaos/blob/master/decklinksdk.rb), [gtkdialog](https://github.com/amiaopensource/homebrew-amiaos/blob/master/gtkdialog.rb), freetype, sdl and xmlstarlet. Optional dependencies are: deckcontrol, gnuplot, mediaconch, mkvtoolnix, mpv and qcli.
+Vrecord uses MediaArea’s [ffmpeg-ma](https://github.com/MediaArea/homebrew-mediaarea/blob/master/ffmpeg-ma.rb) to do its dirty work. Other dependencies are: cowsay, [decklinksdk](https://github.com/amiaopensource/homebrew-amiaos/blob/master/decklinksdk.rb), [gtkdialog](https://github.com/amiaopensource/homebrew-amiaos/blob/master/gtkdialog.rb), freetype, sdl, and xmlstarlet. Optional dependencies are: deckcontrol, gnuplot, mediaconch, mkvtoolnix, mpv and qcli.
 
-Currently vrecord supports macOS or Linux, and Blackmagic Design capture cards with the Blackmagic driver installed or
+Currently vrecord supports macOS and Linux, and Blackmagic Design capture cards with the Blackmagic driver installed or
 AVFoundation for DV capture on macOS. Some notes on [needed hardware](Resources/Documentation/hardware.md) are provided.
 
-If you want to see a more detailed description about how to digitize analog videotape see our document on [analog digitization](Resources/Documentation/analog_digitization.md).
+If you want to see a more detailed description of how to digitize analog videotape, see our document on [analog digitization](Resources/Documentation/analog_digitization.md).
 
 
 ## Contributing
@@ -64,10 +64,7 @@ The vrecord Team
 ## Maintainers
 The vrecord maintainers are:
 
-Dave Rice (@dericed)
-
-Ben Turkus (@bturkus)
-
-Annie Schwiekert (@aeschweik)
-
-Andrew Weaver (@privatezero)
+- Dave Rice (@dericed)
+- Ben Turkus (@bturkus)
+- Annie Schwiekert (@aeschweik)
+- Andrew Weaver (@privatezero)