Skip to content
This repository has been archived by the owner on Sep 27, 2018. It is now read-only.

Commit

Permalink
Merge 16caa87 into e1cfedf
Browse files Browse the repository at this point in the history
  • Loading branch information
l2dy committed Jun 1, 2017
2 parents e1cfedf + 16caa87 commit 692ede7
Show file tree
Hide file tree
Showing 5 changed files with 22 additions and 22 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.rst
Expand Up @@ -64,7 +64,7 @@ Changelog

Hey, the stable is here!

* Completed documentation: http://storyboard.rtfd.org
* Completed documentation: https://storyboard.readthedocs.io
* Added ``--include-sha1sum`` option to console script ``storyboard``
(useful when SHA-1 digest is disabled from config file)
* Fixed frame extraction when video duration is missing or wrong in
Expand Down
16 changes: 8 additions & 8 deletions README.md
Expand Up @@ -7,7 +7,7 @@
[![Windows Build Status](https://ci.appveyor.com/api/projects/status/github/zmwangx/storyboard?branch=master&svg=true)](https://ci.appveyor.com/project/zmwangx/storyboard)
[![Coverage Status](https://coveralls.io/repos/github/zmwangx/storyboard/badge.svg?branch=master)](https://coveralls.io/github/zmwangx/storyboard?branch=master)

*Main documentation on Read the Docs:* http://storyboard.rtfd.org
*Main documentation on Read the Docs:* https://storyboard.readthedocs.io

*Caution: Development has been deferred indefinitely as of July
23, 2015. However, contributions are welcome, and the maintainer will
Expand All @@ -28,13 +28,13 @@ Note that this README only provides an overview and summary of the topics listed

## Background

*Main article:* http://storyboard.rtfd.org/en/latest/index.html
*Main article:* https://storyboard.readthedocs.io/en/latest/index.html

`storyboard` was inspired by the storyboards I frequently encounter on video-sharing Internet forums, mostly generated by proprietary video players. Those storyboards often come with video/file metadata bundled, which I see as a great all-in-one solution for video sharing, saving one the labor of typing multiple console commands, copying and pasting output, and worrying about the forum's crappy formatting. However, I, for one, dislike proprietary players. Also, those storyboards are usually ugly and uninformative, using stupid fonts and lacking crucial information that hackers look for (e.g., hash). Therefore, I developed this customizable storyboard generator for hackers.

## Installation and dependencies

*Main article:* http://storyboard.rtfd.org/en/latest/install.html
*Main article:* https://storyboard.readthedocs.io/en/latest/install.html

### Dependencies

Expand All @@ -54,26 +54,26 @@ Developers should clone the git repo for docs, tests, and more.

## Command-line usage

*Main article:* http://storyboard.rtfd.org/en/latest/cli.html
*Main article:* https://storyboard.readthedocs.io/en/latest/cli.html

This package installs two console scripts, `metadata` and `storyboard`. You may find documentation of both using the `-h,--help` option. Extensive documentation is also available for both:

* `metadata` CLI reference: [metadata-cli.html](http://storyboard.rtfd.org/en/latest/metadata-cli.html);
* `storyboard` CLI reference: [storyboard-cli.html](http://storyboard.rtfd.org/en/latest/storyboard-cli.html).
* `metadata` CLI reference: [metadata-cli.html](https://storyboard.readthedocs.io/en/latest/metadata-cli.html);
* `storyboard` CLI reference: [storyboard-cli.html](https://storyboard.readthedocs.io/en/latest/storyboard-cli.html).

By the way, the default invocation is really simple (for both): just supply one or more video paths.

## Sample storyboards

*Main article:* http://storyboard.rtfd.org/en/latest/sample.html
*Main article:* https://storyboard.readthedocs.io/en/latest/sample.html

[![](https://i.imgur.com/OIx20KQ.jpg)](https://i.imgur.com/gtBArx7.jpg)

[![](https://i.imgur.com/WB2N0Rh.jpg)](https://i.imgur.com/Ujgsznc.jpg)

## Issues

*Main article:* http://storyboard.rtfd.org/en/latest/issue.html
*Main article:* https://storyboard.readthedocs.io/en/latest/issue.html

### Reporting

Expand Down
18 changes: 9 additions & 9 deletions README.rst
@@ -1,7 +1,7 @@
|Latest Version| |Supported Python versions| |License| |Docs|
|Build Status| |Windows Build Status| |Coverage Status|

*Main documentation on Read the Docs:* http://storyboard.rtfd.org
*Main documentation on Read the Docs:* https://storyboard.readthedocs.io

*Caution: Development has been deferred indefinitely as of July*
*23, 2015. However, contributions are welcome, and the maintainer will*
Expand Down Expand Up @@ -35,7 +35,7 @@ Structure of this document
Background
----------

*Main article:* http://storyboard.rtfd.org/en/latest/index.html
*Main article:* https://storyboard.readthedocs.io/en/latest/index.html

``storyboard`` was inspired by the storyboards I frequently encounter on
video-sharing Internet forums, mostly generated by proprietary video
Expand All @@ -51,7 +51,7 @@ this customizable storyboard generator for hackers.
Installation and dependencies
-----------------------------

*Main article:* http://storyboard.rtfd.org/en/latest/install.html
*Main article:* https://storyboard.readthedocs.io/en/latest/install.html

Dependencies
~~~~~~~~~~~~
Expand Down Expand Up @@ -84,25 +84,25 @@ Developers should clone the git repo for docs, tests, and more.
Command-line usage
------------------

*Main article:* http://storyboard.rtfd.org/en/latest/cli.html
*Main article:* https://storyboard.readthedocs.io/en/latest/cli.html

This package installs two console scripts, ``metadata`` and
``storyboard``. You may find documentation of both using the
``-h,--help`` option. Extensive documentation is also available for
both:

- ``metadata`` CLI reference:
`metadata-cli.html <http://storyboard.rtfd.org/en/latest/metadata-cli.html>`__;
`metadata-cli.html <https://storyboard.readthedocs.io/en/latest/metadata-cli.html>`__;
- ``storyboard`` CLI reference:
`storyboard-cli.html <http://storyboard.rtfd.org/en/latest/storyboard-cli.html>`__.
`storyboard-cli.html <https://storyboard.readthedocs.io/en/latest/storyboard-cli.html>`__.

By the way, the default invocation is really simple (for both): just
supply one or more video paths.

Sample storyboards
------------------

*Main article:* http://storyboard.rtfd.org/en/latest/sample.html
*Main article:* https://storyboard.readthedocs.io/en/latest/sample.html

|image10|

Expand All @@ -111,7 +111,7 @@ Sample storyboards
Issues
------

*Main article:* http://storyboard.rtfd.org/en/latest/issue.html
*Main article:* https://storyboard.readthedocs.io/en/latest/issue.html

Reporting
~~~~~~~~~
Expand Down Expand Up @@ -230,7 +230,7 @@ Changelog

Hey, the stable is here!

* Completed documentation: http://storyboard.rtfd.org
* Completed documentation: https://storyboard.readthedocs.io
* Added ``--include-sha1sum`` option to console script ``storyboard``
(useful when SHA-1 digest is disabled from config file)
* Fixed frame extraction when video duration is missing or wrong in
Expand Down
4 changes: 2 additions & 2 deletions src/storyboard/metadata.py
Expand Up @@ -1234,8 +1234,8 @@ def main():
in https://docs.python.org/3/library/configparser.html).
For more detailed explanations, see
http://storyboard.rtfd.org/en/stable/metadata-cli.html (or replace
"stable" with the version you are using).
https://storyboard.readthedocs.io/en/stable/metadata-cli.html (or
replace "stable" with the version you are using).
"""
parser = argparse.ArgumentParser(description=description)
parser.add_argument(
Expand Down
4 changes: 2 additions & 2 deletions src/storyboard/storyboard.py
Expand Up @@ -1068,8 +1068,8 @@ def main():
wrapper script around the storyboard.storyboard if you'd like to.
For more detailed explanations, see
http://storyboard.rtfd.org/en/stable/storyboard-cli.html (or replace
"stable" with the version you are using).
https://storyboard.readthedocs.io/en/stable/storyboard-cli.html (or
replace "stable" with the version you are using).
"""
parser = argparse.ArgumentParser(description=description)
parser.add_argument(
Expand Down

0 comments on commit 692ede7

Please sign in to comment.