diff options
| -rw-r--r-- | README.markdown | 43 | ||||
| -rw-r--r-- | README.md | 15 | ||||
| -rw-r--r-- | TRANSLATIONS | 19 |
3 files changed, 43 insertions, 34 deletions
diff --git a/README.markdown b/README.markdown new file mode 100644 index 000000000..9e15ed2b4 --- /dev/null +++ b/README.markdown @@ -0,0 +1,43 @@ +# HandBrake + +HandBrake is an open-source video transcoder available for Linux, Mac, and Windows, licensed under the [GNU General Public License (GPL) Version 2](LICENSE). + +HandBrake takes videos you already have and makes new ones that work on your mobile phone, tablet, TV media player, game console, computer, or web browser—nearly anything that supports modern video formats. + +HandBrake works with most common video files and formats, including ones created by consumer and professional video cameras, mobile devices such as phones and tablets, game and computer screen recordings, and DVD and Blu-ray discs. HandBrake leverages tools such as Libav, x264, and x265 to create new MP4 or MKV video files from these *Sources*. + +For information on downloading, building/installing, and using HandBrake, see the official [HandBrake Documentation](https://handbrake.fr/docs). + + +## Community Support + +Visit the [HandBrake Community Forums](https://forum.handbrake.fr/). + +Chat on \#handbrake on [Freenode IRC](http://freenode.net/irc_servers.shtml) (irc://irc.freenode.net/#handbrake). + +For information on HandBrake's community support channels, please see [Community Support](https://handbrake.fr/docs/en/latest/help/community-support.html). + + +## Contributing + +We welcome most contributions. While it is our goal to allow everyone to contribute, contributions not meeting the project's standards may be rejected. If this happens to you, don't fret. We usually provide reasons for rejection to give you the opportunity to correct anything out of place. Consider asking first before attempting to make sweeping changes. + +First fork the HandBrake repository using GitHub's web interface, and clone the fork to your local machine (`git clone my-fork`). Then create and switch to an appropriately named local branch to track your changes (`git checkout master; git checkout --branch branch-name`). This allows you to make as many changes as you like without affecting the `master` branch, and helps identify groups of changes when submitting pull requests later on. + +To make a change, edit the appropriate file(s), commit them to your local branch (`git add changed-files; git commit`), and push the branch to your fork on GitHub (`git push my-fork branch-name`). You're now ready to open a pull request using GitHub's web interface. + +For more on this workflow, read [Understanding the GitHub Flow](https://guides.github.com/introduction/flow/). + +### Translations + +The Mac and Windows GUIs are currently only available in English, and do not support other translations at this time. + +The Linux GUI is currently available in multiple languages thanks to the [HandBrake Transifex project](https://www.transifex.com/victorr2007/handbrake/) created by Victorr2007. If you would like to help translate HandBrake in your language, [go there now](https://www.transifex.com/victorr2007/handbrake/). + + +## Additional Information + +[Authors](AUTHORS.markdown) +[License](LICENSE) +[News](NEWS.markdown) +[Thanks](THANKS.markdown) diff --git a/README.md b/README.md deleted file mode 100644 index b9ad17d49..000000000 --- a/README.md +++ /dev/null @@ -1,15 +0,0 @@ -## [HandBrake Repository](#___top) -### GitHub -The main development repository for the HandBrake Project can be found on GitHub at [Official HandBrake Source Repository](https://github.com/HandBrake/HandBrake "Official HandBrake Source Repository") -### HandBrake -HandBrake is a tool for converting video from nearly any format to a selection of modern, widely supported codecs. -### Community -**IRC:** [\#Handbrake](irc://irc.freenode.net/#handbrake) and [\#Handbrake-dev](irc://irc.freenode.net/#handbrake-dev) on Freenode. - -**Support:** [Community Forums](https://forum.handbrake.fr/) - -### Submitting a Patch - -Patches are always welcome and can be submitted here on github as a pull request. - -For guidance, please feel free to get in touch on our IRC channels listed above. diff --git a/TRANSLATIONS b/TRANSLATIONS deleted file mode 100644 index eafe7a1a3..000000000 --- a/TRANSLATIONS +++ /dev/null @@ -1,19 +0,0 @@ -TRANSLATIONS file for HandBrake <http://handbrake.fr/> - -Translating HandBrake -===================== - -For the UIs that support translation, these can be submitted on our community forum or reviewboard site. - -Mac GUI: - - Translations are not currently supported in this UI. This may be supported at a later point. - -Windows GUI: - - Translations are not currently supported in this UI. This may be supported at a later point. - -Linux GUI: - - Russian - - Czech - - - |