ffmprovisr/readme.md

108 lines
5.4 KiB
Markdown
Raw Normal View History

2016-01-10 16:09:47 +01:00
# [ffmprovisr](http://amiaopensource.github.io/ffmprovisr)
Repository of useful FFmpeg command lines for archivists!
## What is this?
2017-04-19 10:13:17 +02:00
#### 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.
## How do I see it?
2017-05-17 18:50:29 +02:00
The code is found in the gh-pages branch (the default primary branch). Readme is right here. You can see the site live on [GitHub pages](http://amiaopensource.github.io/ffmprovisr).
2017-05-17 19:27:19 +02:00
You can also install the latest [release](https://github.com/amiaopensource/ffmprovisr/releases) on your computer with the command:
2017-05-17 18:50:29 +02:00
```
brew install amiaopensource/amiaos/ffmprovisr
```
and then call it locally with the command:
```
ffmprovisr
```
This works currently under macOS, Linux and the Linux subsystem on Windows. On classic Windows you can install the last [release](https://github.com/amiaopensource/ffmprovisr/releases) manually and the open `index.html` in a browser.
## How do I contribute?
2017-04-19 09:33:51 +02:00
You are welcome to edit the codebase yourself, or just supply the information and ask it to be added to the site.
2017-04-19 09:33:51 +02:00
#### Edit codebase
2017-04-19 09:33:51 +02:00
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
2017-07-14 10:57:41 +02:00
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.
2017-04-19 09:33:51 +02:00
#### General help
2016-07-21 23:40:33 +02:00
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.
2016-01-24 16:20:15 +01:00
## Code of Conduct
You can read our contributor code of conduct [here](https://github.com/amiaopensource/ffmprovisr/blob/gh-pages/code_of_conduct.md).
## Maintainers
[Ashley Blewer](https://github.com/ablwr), [Katherine Frances Nagels](https://github.com/kfrn), [Kieran O'Leary](https://github.com/kieranjol) and [Reto Kromer](https://github.com/retokromer)
## Contributors
* Gathered using [octohatrack](https://github.com/LABHR/octohatrack)
2017-05-22 15:59:43 +02:00
*GitHub Contributors*:
ablwr (Ashley)
dericed (Dave Rice)
edsu (Ed Summers)
jfarbowitz (Jonathan Farbowitz)
kfrn (Katherine Frances Nagels)
kgrons (Kathryn Gronsbell)
kieranjol (Kieran O'Leary)
llogan (Lou)
2017-05-22 15:59:43 +02:00
pjotrek-b (Peter B.)
privatezero (Andrew Weaver)
retokromer (Reto Kromer)
rfraimow
2017-05-22 15:59:43 +02:00
*All Contributors*:
ablwr (Ashley)
audiovisualopen
brainwane (Sumana Harihareswara)
2017-05-22 15:59:43 +02:00
bturkus
dericed (Dave Rice)
edsu (Ed Summers)
Fizz24
2017-05-22 15:59:43 +02:00
jamessam (Jim Sam)
jfarbowitz (Jonathan Farbowitz)
jronallo (Jason Ronallo)
2017-05-22 15:59:43 +02:00
kellyhaydon (metacynic)
kfrn (Katherine Frances Nagels)
kgrons (Kathryn Gronsbell)
kieranjol (Kieran O'Leary)
llogan (Lou)
mulvya
2017-05-22 15:59:43 +02:00
pjotrek-b (Peter B.)
privatezero (Andrew Weaver)
retokromer (Reto Kromer)
rfraimow
2017-05-22 15:59:43 +02:00
richardpl (Paul B Mahol)
todrobbins (Tod Robbins)
2017-05-22 15:59:43 +02:00
Repo: amiaopensource/ffmprovisr
2017-05-22 15:59:43 +02:00
GitHub Contributors: 12
All Contributors: 22
## AVHack Team
[Association of Moving Image Archivists & Digital Library Federation Hack Day 2015](http://wiki.curatecamp.org/index.php/Association_of_Moving_Image_Archivists_%26_Digital_Library_Federation_Hack_Day_2015)
2017-04-19 09:33:51 +02:00
[Ashley Blewer](https://github.com/ablwr), [Eddy Colloton](https://github.com/eddycolloton), Rebecca Dillmeier, [Jonathan Farbowitz](https://github.com/jfarbowitz), [Rebecca Fraimow](https://github.com/rfraimow), Samuel Gutterman, [Kelly Haydon](https://github.com/kellyhaydon), [Reto Kromer](https://github.com/retokromer), Nicole Martin, [Katherine Frances Nagels](https://github.com/kfrn), [Kieran O'Leary](https://github.com/kieranjol), Catriona Schlosser, [Ben Turkus](https://github.com/bturkus)
2016-11-06 22:04:41 +01:00
## Sister projects
2016-11-07 00:36:32 +01:00
[Script Ahoy](http://dd388.github.io/crals/): Community Resource for Archivists and Librarians Scripting
[sourcecaster](https://datapraxis.github.io/sourcecaster/): helps you use the command line to work through common challenges that come up when working with digital primary sources.
## License
<a rel="license" href="http://creativecommons.org/licenses/by/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by/4.0/80x15.png" /></a><br />This <span xmlns:dct="http://purl.org/dc/terms/" href="http://purl.org/dc/dcmitype/InteractiveResource" rel="dct:type">work</span> by <a xmlns:cc="http://creativecommons.org/ns#" href="http://amiaopensource.github.io/ffmprovisr/" property="cc:attributionName" rel="cc:attributionURL">ffmprovisr</a> is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by/4.0/">Creative Commons Attribution 4.0 International License</a>.<br />Based on a work at <a xmlns:dct="http://purl.org/dc/terms/" href="https://github.com/amiaopensource/ffmprovisr" rel="dct:source">https://github.com/amiaopensource/ffmprovisr</a>.