diff --git a/.gitignore b/.gitignore
index 8508d396ea..354bb10951 100644
--- a/.gitignore
+++ b/.gitignore
@@ -61,14 +61,13 @@ target/
# Misc
_*
*_
-README.html
-README.rst
*.3gp
*.asf
*.download
*.f4v
*.flv
*.gif
+*.html
*.jpg
*.lrc
*.mkv
diff --git a/Makefile b/Makefile
index 647031cd14..288673f94d 100644
--- a/Makefile
+++ b/Makefile
@@ -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
@@ -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
@@ -43,6 +42,6 @@ bdist_wheel:
install:
$(SETUP) install
-release: rst
+release:
zenity --question
$(SETUP) sdist bdist_wheel upload --sign
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000000..3c23ab5e50
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,58 @@
+You-Get
+=======
+
+|PyPI version| |Build Status| |Gitter|
+
+`You-Get `__ 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 `__:
+
+.. 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 `__ 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
diff --git a/setup.py b/setup.py
index 4ea32ad6b2..42ede78f43 100755
--- a/setup.py
+++ b/setup.py
@@ -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'},