Skip to content

Commit

Permalink
add a separate README.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
soimort committed Oct 22, 2015
1 parent 083f97a commit 8aea336
Show file tree
Hide file tree
Showing 4 changed files with 63 additions and 7 deletions.
3 changes: 1 addition & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -61,14 +61,13 @@ target/
# Misc
_*
*_
README.html
README.rst
*.3gp
*.asf
*.download
*.f4v
*.flv
*.gif
*.html
*.jpg
*.lrc
*.mkv
Expand Down
7 changes: 3 additions & 4 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
SETUP = python3 setup.py

.PHONY: default i test clean all html rst build sdist bdist bdist_egg bdist_wheel install rst release
.PHONY: default i test clean all html rst build sdist bdist bdist_egg bdist_wheel install release

default: i

Expand All @@ -12,12 +12,11 @@ test:

clean:
zenity --question
rm -f README.rst
rm -fr build/ dist/ src/*.egg-info/
find . | grep __pycache__ | xargs rm -fr
find . | grep .pyc | xargs rm -f

all: rst build sdist bdist bdist_egg bdist_wheel
all: build sdist bdist bdist_egg bdist_wheel

html:
pandoc README.md > README.html
Expand All @@ -43,6 +42,6 @@ bdist_wheel:
install:
$(SETUP) install

release: rst
release:
zenity --question
$(SETUP) sdist bdist_wheel upload --sign
58 changes: 58 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
You-Get
=======

|PyPI version| |Build Status| |Gitter|

`You-Get <https://you-get.org/>`__ is a tiny command-line utility to
download media contents (videos, audios, images) from the Web, in case
there is no other handy way to do it.

Here's how you use ``you-get`` to download a video from `this web
page <http://www.fsf.org/blogs/rms/20140407-geneva-tedx-talk-free-software-free-society>`__:

.. code:: console
$ you-get http://www.fsf.org/blogs/rms/20140407-geneva-tedx-talk-free-software-free-society
Site: fsf.org
Title: TEDxGE2014_Stallman05_LQ
Type: WebM video (video/webm)
Size: 27.12 MiB (28435804 Bytes)
Downloading TEDxGE2014_Stallman05_LQ.webm ...
100.0% ( 27.1/27.1 MB) ├████████████████████████████████████████┤[1/1] 12 MB/s
And here's why you might want to use it:

- You enjoyed something on the Internet, and just want to download them
for your own pleasure.
- You watch your favorite videos online from your computer, but you are
prohibited from saving them. You feel that you have no control over
your own computer. (And it's not how an open Web is supposed to
work.)
- You want to get rid of any closed-source technology or proprietary
JavaScript code, and disallow things like Flash running on your
computer.
- You are an adherent of hacker culture and free software.

What ``you-get`` can do for you:

- Download videos / audios from popular websites such as YouTube,
Youku, Niconico, and a bunch more. (See the `full list of supported
sites <#supported-sites>`__)
- Stream an online video in your media player. No web browser, no more
ads.
- Download images (of interest) by scraping a web page.
- Download arbitrary non-HTML contents, i.e., binary files.

Interested? `Install it <#installation>`__ now and `get started by
examples <#getting-started>`__.

Are you a Python programmer? Then check out `the
source <https://github.com/soimort/you-get>`__ and fork it!

.. |PyPI version| image:: https://badge.fury.io/py/you-get.png
:target: http://badge.fury.io/py/you-get
.. |Build Status| image:: https://api.travis-ci.org/soimort/you-get.png
:target: https://travis-ci.org/soimort/you-get
.. |Gitter| image:: https://badges.gitter.im/Join%20Chat.svg
:target: https://gitter.im/soimort/you-get?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
description = proj_info['description'],
keywords = proj_info['keywords'],

long_description = README + '\n\n' + CHANGELOG,
long_description = README,

packages = find_packages('src'),
package_dir = {'' : 'src'},
Expand Down

0 comments on commit 8aea336

Please sign in to comment.