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

Updated ReadMe for Avidemux Github Repository for increased relevance, information, and clarity of the Avidemux application. #526

Open
wants to merge 8 commits into
base: master
Choose a base branch
from

Conversation

kaimcfarlane
Copy link

The original Avidemux ReadMe left out some essential information about the application and omitted key details that would be valuable to both users and developers. This pull request updates the ReadMe to address those gaps in documentation, providing relevant information to enhance user experience and streamline contributions to the Avidemux project.

The following updates/changes were added:

  • Enhanced the introduction to the Avidemux application by providing more detailed information, including programming languages used, supported file types, and additional details such as BSD support and free pricing.
  • Introduced a table of contents to improve user navigation within the ReadMe.
  • Added a link to the official Avidemux website for easy access.
  • Created a new "Why Avidemux?" section to emphasize what sets Avidemux apart from other video editing tools.
  • Developed a "Main Features" section to showcase the key features users can expect from Avidemux.
  • Renamed the "Build" section to "Installation" for better visibility and clarity for developers.
  • Included an "Examples" section to provide users with visual examples of Avidemux in action, ensuring proper setup and functionality.
  • Added a "Documentation and Support" section to guide users towards available support and updates.
  • Created a "Collaborators" section to recognize contributors and encourage community involvement in the project.

Added supported file types and a more detailed description of Avidemux.

Added link to website as well as documentation and contributor sections.

Added images of different pages of application so user know what their application should look like when brought to their own development machine.
Added Why Us and Features section to ReadMe.

Added reddit forum to documentation section.
Fixed spelling of supported.
Added table of contents for all headings.
Added new images and examples of the four different windows in Avidemux.
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