From 6c5aaeb20bbfcf221a7378d23663a68fa1a56409 Mon Sep 17 00:00:00 2001 From: Davidson Fellipe Date: Thu, 19 Nov 2015 11:28:23 -0500 Subject: [PATCH] Prettify readme --- README.md | 47 ++++++++++++++++++++++++++++++++++++++--------- 1 file changed, 38 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 1927d4e..f095ad2 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,32 @@ -# video-thumbnail-generator -Generate thumbnail sprites from videos. +# Video thumbnail generator +> Generate thumbnail sprites from videos. + +## Why -### Why? ![image](https://cloud.githubusercontent.com/assets/244265/11234416/b1a67230-8d95-11e5-97a4-c2acdcbf72f7.png) -Almost all video players enhances user's seekbar navigation by providing a thumbnail preview of the moments where the user want to seek. This is a python script that, given a video, generate a thumbnail sprite image from it. +Generate a thumbnail sprite shouldn't be hard, because almost all video players enhances user's seekbar navigation by providing a thumbnail preview of the moments where the user want to seek. This is a python script that, given a video, generate a thumbnail sprite image from it. -### Build +## Build -Clone this repository. On project folder: +1. Clone it: + +```sh +$ git clone git@github.com:flavioribeiro/video-thumbnail-generator.git +``` + +2. Then go to the project's folder: + +```sh +$ cd video-thumbnail-generator +``` + +3. And finally run: ```shell $ chmod a+x build && ./build ``` -### Run +## Run ```shell $ ./generator --help Video Thumbnail Generator @@ -34,7 +47,7 @@ Options: Output. ``` -### Example +## Example ```shell $ ./generator videos/27467_1_milkbots_wg_720p.mp4 2 126 73 10 thumbnails.jpg Extracting 101 frames @@ -44,6 +57,22 @@ Saved! ![image](https://cloud.githubusercontent.com/assets/244265/11234316/b42913a6-8d94-11e5-865a-128ea8d801f7.png) -#### License + +## Browser Support + +![IE](https://cloud.githubusercontent.com/assets/398893/3528325/20373e76-078e-11e4-8e3a-1cb86cf506f0.png) | ![Chrome](https://cloud.githubusercontent.com/assets/398893/3528328/23bc7bc4-078e-11e4-8752-ba2809bf5cce.png) | ![Firefox](https://cloud.githubusercontent.com/assets/398893/3528329/26283ab0-078e-11e4-84d4-db2cf1009953.png) | ![Opera](https://cloud.githubusercontent.com/assets/398893/3528330/27ec9fa8-078e-11e4-95cb-709fd11dac16.png) | ![Safari](https://cloud.githubusercontent.com/assets/398893/3528331/29df8618-078e-11e4-8e3e-ed8ac738693f.png) +--- | --- | --- | --- | --- | +IE 9+ ✔ | Latest ✔ | Latest ✔ | Latest ✔ | Latest ✔ | + + +## Contributing + +1. Fork it! +2. Create your feature branch: `git checkout -b my-awesome-new-feature` +3. Commit your changes: `git commit -m 'Add some awesome feature'` +4. Push to the branch: `git push origin my-awesome-new-feature` +5. Submit a pull request :] + +## License This code is under [Apache License](https://github.com/flavioribeiro/video-thumbnail-generator/blob/master/LICENSE).