diff --git a/readme.md b/readme.md index 6d4572b..b3c4c61 100644 --- a/readme.md +++ b/readme.md @@ -15,7 +15,7 @@ Repository of useful FFmpeg command lines for archivists! ## What is this? -#### Project Objective +### Project Objective To facilitate better understanding of FFmpeg through collaborative sharing of useful scripts and detailed flag-level description of how each script works, so archivists can copy-paste and produce their own scripts, but also understand how and why they work. @@ -34,7 +34,7 @@ ffmprovisr ``` This works currently under macOS, Linux and the Linux apps on Windows (Ubuntu and Debian tested). On classic Windows you can install the last [release](https://github.com/amiaopensource/ffmprovisr/releases) manually and the open `index.html` in a browser. -#### Parseable list of the commands +### Parseable list of the commands A list of all recipes in an easily parseable [ASCII text](recipes.txt) format is provided as well. It contains for each recipe its title and command in the following format: @@ -58,15 +58,15 @@ The used [one-liner](scripts/get_recipe_list) is in the `scripts` folder. You are welcome to edit the codebase yourself, or just supply the information and ask it to be added to the site. -#### Edit codebase +### Edit codebase To contribute to this project directly (and more quickly), clone this repository and create a new branch (`git checkout -b your-branch-name`) and add or modify a new block in `index.html`. Then [submit a pull request](https://github.com/amiaopensource/ffmprovisr/pulls) and the maintainers will review and integrate your code. There is a commented-out sample block available at the bottom of `index.html` that can be as a guideline for your command. -#### Make a request +### Make a request If you are having trouble with coding it yourself or with GitHub, feel free to [submit an issue](https://github.com/amiaopensource/ffmprovisr/issues) with the kind of command you would like to see added to the site. -#### General help +### General help If you want to help but don't have a new script to add, you can help us by testing out the scripts available, by refining or clarifying the documentation, or [creating an issue](https://github.com/amiaopensource/ffmprovisr/issues) for anything that sounds confusing and requires clarification. @@ -80,7 +80,7 @@ You can read our contributor code of conduct [here](https://github.com/amiaopens ## Contributors * Gathered using [octohatrack](https://github.com/LABHR/octohatrack) - + *Code Contributors*: ablwr (Ashley) alavigne12 (A. Lavigne) @@ -102,7 +102,7 @@ pjotrek-b (Peter B.) privatezero (Andrew Weaver) retokromer (Reto Kromer) rfraimow - + All Contributors: ablwr (Ashley) alavigne12 (A. Lavigne) @@ -141,11 +141,11 @@ richardpl (Paul B Mahol) ross-spencer (Ross Spencer) taschenbach (Tommy Aschenbach) todrobbins (Tod Robbins) - + Repo: amiaopensource/ffmprovisr GitHub Contributors: 20 All Contributors: 37 -Last updated: 2019-12-11 +Last updated: 2019-12-11 ## AVHack Team