Prettify readme
This commit is contained in:
47
README.md
47
README.md
@@ -1,19 +1,32 @@
|
|||||||
# video-thumbnail-generator
|
# Video thumbnail generator
|
||||||
Generate thumbnail sprites from videos.
|
> Generate thumbnail sprites from videos.
|
||||||
|
|
||||||
|
## Why
|
||||||
|
|
||||||
### Why?
|
|
||||||

|

|
||||||
|
|
||||||
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
|
```shell
|
||||||
$ chmod a+x build && ./build
|
$ chmod a+x build && ./build
|
||||||
```
|
```
|
||||||
|
|
||||||
### Run
|
## Run
|
||||||
```shell
|
```shell
|
||||||
$ ./generator --help
|
$ ./generator --help
|
||||||
Video Thumbnail Generator
|
Video Thumbnail Generator
|
||||||
@@ -34,7 +47,7 @@ Options:
|
|||||||
<output> Output.
|
<output> Output.
|
||||||
```
|
```
|
||||||
|
|
||||||
### Example
|
## Example
|
||||||
```shell
|
```shell
|
||||||
$ ./generator videos/27467_1_milkbots_wg_720p.mp4 2 126 73 10 thumbnails.jpg
|
$ ./generator videos/27467_1_milkbots_wg_720p.mp4 2 126 73 10 thumbnails.jpg
|
||||||
Extracting 101 frames
|
Extracting 101 frames
|
||||||
@@ -44,6 +57,22 @@ Saved!
|
|||||||
|
|
||||||

|

|
||||||
|
|
||||||
#### License
|
|
||||||
|
## Browser Support
|
||||||
|
|
||||||
|
 |  |  |  | 
|
||||||
|
--- | --- | --- | --- | --- |
|
||||||
|
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).
|
This code is under [Apache License](https://github.com/flavioribeiro/video-thumbnail-generator/blob/master/LICENSE).
|
||||||
|
|||||||
Reference in New Issue
Block a user