Skip to content

Commit 8aea336

Browse files
committed
add a separate README.rst
1 parent 083f97a commit 8aea336

File tree

4 files changed

+63
-7
lines changed

4 files changed

+63
-7
lines changed

.gitignore

+1-2
Original file line numberDiff line numberDiff line change
@@ -61,14 +61,13 @@ target/
6161
# Misc
6262
_*
6363
*_
64-
README.html
65-
README.rst
6664
*.3gp
6765
*.asf
6866
*.download
6967
*.f4v
7068
*.flv
7169
*.gif
70+
*.html
7271
*.jpg
7372
*.lrc
7473
*.mkv

Makefile

+3-4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
SETUP = python3 setup.py
22

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

55
default: i
66

@@ -12,12 +12,11 @@ test:
1212

1313
clean:
1414
zenity --question
15-
rm -f README.rst
1615
rm -fr build/ dist/ src/*.egg-info/
1716
find . | grep __pycache__ | xargs rm -fr
1817
find . | grep .pyc | xargs rm -f
1918

20-
all: rst build sdist bdist bdist_egg bdist_wheel
19+
all: build sdist bdist bdist_egg bdist_wheel
2120

2221
html:
2322
pandoc README.md > README.html
@@ -43,6 +42,6 @@ bdist_wheel:
4342
install:
4443
$(SETUP) install
4544

46-
release: rst
45+
release:
4746
zenity --question
4847
$(SETUP) sdist bdist_wheel upload --sign

README.rst

+58
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
You-Get
2+
=======
3+
4+
|PyPI version| |Build Status| |Gitter|
5+
6+
`You-Get <https://you-get.org/>`__ is a tiny command-line utility to
7+
download media contents (videos, audios, images) from the Web, in case
8+
there is no other handy way to do it.
9+
10+
Here's how you use ``you-get`` to download a video from `this web
11+
page <http://www.fsf.org/blogs/rms/20140407-geneva-tedx-talk-free-software-free-society>`__:
12+
13+
.. code:: console
14+
15+
$ you-get http://www.fsf.org/blogs/rms/20140407-geneva-tedx-talk-free-software-free-society
16+
Site: fsf.org
17+
Title: TEDxGE2014_Stallman05_LQ
18+
Type: WebM video (video/webm)
19+
Size: 27.12 MiB (28435804 Bytes)
20+
21+
Downloading TEDxGE2014_Stallman05_LQ.webm ...
22+
100.0% ( 27.1/27.1 MB) ├████████████████████████████████████████┤[1/1] 12 MB/s
23+
24+
And here's why you might want to use it:
25+
26+
- You enjoyed something on the Internet, and just want to download them
27+
for your own pleasure.
28+
- You watch your favorite videos online from your computer, but you are
29+
prohibited from saving them. You feel that you have no control over
30+
your own computer. (And it's not how an open Web is supposed to
31+
work.)
32+
- You want to get rid of any closed-source technology or proprietary
33+
JavaScript code, and disallow things like Flash running on your
34+
computer.
35+
- You are an adherent of hacker culture and free software.
36+
37+
What ``you-get`` can do for you:
38+
39+
- Download videos / audios from popular websites such as YouTube,
40+
Youku, Niconico, and a bunch more. (See the `full list of supported
41+
sites <#supported-sites>`__)
42+
- Stream an online video in your media player. No web browser, no more
43+
ads.
44+
- Download images (of interest) by scraping a web page.
45+
- Download arbitrary non-HTML contents, i.e., binary files.
46+
47+
Interested? `Install it <#installation>`__ now and `get started by
48+
examples <#getting-started>`__.
49+
50+
Are you a Python programmer? Then check out `the
51+
source <https://github.com/soimort/you-get>`__ and fork it!
52+
53+
.. |PyPI version| image:: https://badge.fury.io/py/you-get.png
54+
:target: http://badge.fury.io/py/you-get
55+
.. |Build Status| image:: https://api.travis-ci.org/soimort/you-get.png
56+
:target: https://travis-ci.org/soimort/you-get
57+
.. |Gitter| image:: https://badges.gitter.im/Join%20Chat.svg
58+
:target: https://gitter.im/soimort/you-get?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge

setup.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
description = proj_info['description'],
2929
keywords = proj_info['keywords'],
3030

31-
long_description = README + '\n\n' + CHANGELOG,
31+
long_description = README,
3232

3333
packages = find_packages('src'),
3434
package_dir = {'' : 'src'},

0 commit comments

Comments
 (0)