From f463afa1573eb753cd22107c02bdbcb2aee30837 Mon Sep 17 00:00:00 2001 From: Tobin Date: Sun, 5 Apr 2015 21:11:20 -0500 Subject: [PATCH] restructured readme and added changelog updated to match release notes fixed contributors' names complete refactor of readme into separate files, yay for documentation! :fireworks: added release tag links restructured text was janky, fixed the menu line break by the version badges --- CHANGELOG.rst | 39 ++++++++++++ CONTRIBUTORS.rst | 23 +++++++ README.rst | 155 ++++++++++++++++++++++++++++------------------- 3 files changed, 156 insertions(+), 61 deletions(-) create mode 100644 CHANGELOG.rst create mode 100644 CONTRIBUTORS.rst diff --git a/CHANGELOG.rst b/CHANGELOG.rst new file mode 100644 index 0000000..c03dc8d --- /dev/null +++ b/CHANGELOG.rst @@ -0,0 +1,39 @@ +============= +RTV Changelog +============= + +.. _1.2.1: http://github.com/michael-lazar/rtv/releases/tag/v1.2.1 +.. _1.2: http://github.com/michael-lazar/rtv/releases/tag/v1.2 + +------ +1.2.1_ +------ +Bugfixes +* Fixed crashing on invalid subreddit names + +---- +1.2_ +---- +Features + +* Added user login / logout with the `u` key. +* Added subreddit searching with the `f` key. +* Added submission posting with the `p` key. +* Added viewing of user submissions with `/r/me`. +* Program title now displays in the terminal window. +* Gold symbols now display on guilded comments and posts. +* Moved default config location to XDG_CONFIG_HOME. + +Bugfixes + +* Improved error handling for submission / comment posts. +* Fixed handling of unicode flairs. +* Improved displaying of the help message and selfposts on small terminal windows. +* The author's name now correctly highlights in submissions +* Corrected user agent formatting. +* Various minor bugfixes. + +--- +1.1 +--- +* Post comments using your text editor. diff --git a/CONTRIBUTORS.rst b/CONTRIBUTORS.rst new file mode 100644 index 0000000..273168e --- /dev/null +++ b/CONTRIBUTORS.rst @@ -0,0 +1,23 @@ + +================ +RTV Contributors +================ + +Thanks to the following people for their contributions to this project. + +* `michael-lazar `_ +* `Tobin Brown `_ +* `Yusuke Sakamoto `_ +* `Noah Morrison `_ +* `Toby Hughes `_ +* `Shawn Hind `_ +* `mekhami `_ +* `JuanPablo `_ +* `Robert Greener `_ +* `Hans Roman `_ +* `peterpans01 `_ +* `Ram-Z `_ +* `Marc Abramowitz `_ +* `Adam Talsma `_ +* `Wieland Hoffmann `_ +* `Thomas Kajder `_ diff --git a/README.rst b/README.rst index 8505e40..4b28d38 100644 --- a/README.rst +++ b/README.rst @@ -1,32 +1,30 @@ -.. image:: https://pypip.in/version/rtv/badge.svg?text=version&style=flat - :target: https://pypi.python.org/pypi/rtv/ - :alt: Latest Version -.. image:: https://pypip.in/py_versions/rtv/badge.svg?style=flat - :target: https://pypi.python.org/pypi/rtv/ - :alt: Supported Python versions +=========================== +RTV: Reddit Terminal Viewer +=========================== -====================== -Reddit Terminal Viewer -====================== - -Browse Reddit from your terminal +RTV is an application that allows you to view and interact with reddit from your terminal. It is compatible with *most* terminal emulators on Linux and OSX. .. image:: http://i.imgur.com/W1hxqCt.png -RTV is built in **python** using the **curses** library, and is compatible with *most* terminal emulators on Linux and OS X. +RTV is built in **python** using the **curses** library. -------------- -Update (v1.1) -------------- +--------------- -Users can now post comments! +|pypi| |python| -.. image:: http://i.imgur.com/twls7iM.png +--------------- ------------- +* `Installation`_ +* `Configuration`_ +* `Usage`_ +* `Changelog`_ +* `Contributors`_ +* `License`_ + +============ Installation ------------- +============ Install using pip @@ -49,50 +47,10 @@ The installation will place a script in the system path $ rtv $ rtv --help ------ -Usage ------ -RTV currently supports browsing both subreddits and individual submissions. In each mode the controls are slightly different. - -**Global Commands** - -:``▲``/``▼`` or ``j``/``k``: Scroll to the prev/next item -:``a``/``z``: Upvote/downvote the selected item -:``ENTER`` or ``o``: Open the selected item in the default web browser -:``r``: Refresh the current page -:``u``: Login and logout of your user account -:``?``: Show the help screen -:``q``: Quit - -**Subreddit Mode** - -In subreddit mode you can browse through the top submissions on either the front page or a specific subreddit. - -:``►`` or ``l``: View comments for the selected submission -:``/``: Open a prompt to switch subreddits -:``f``: Open a prompt to search the current subreddit -:``p``: Post a new submission to the current subreddit - -The ``/`` prompt accepts subreddits in the following formats - -* ``/r/python`` -* ``/r/python/new`` -* ``/r/python+linux`` supports multireddits -* ``/r/front`` will redirect to the front page -* ``/r/me`` will display your submissions - -**Submission Mode** - -In submission mode you can view the self text for a submission and browse comments. - -:``◄`` or ``h``: Return to subreddit mode -:``►`` or ``l``: Fold the selected comment, or load additional comments -:``c``: Post a new comment on the selected item - -------------- +============= Configuration -------------- +============= RTV will read a configuration file located at ``$XDG_CONFIG_HOME/rtv/rtv.cfg`` or ``~/.config/rtv/rtv.cfg`` if ``$XDG_CONFIG_HOME`` is not set. This can be used to avoid having to re-enter login credentials every time the program is launched. @@ -125,3 +83,78 @@ Set the environment variable ``RTV_EDITOR`` to specify which editor the program .. code-block:: bash $ export RTV_EDITOR=gedit + + +===== +Usage +===== + +RTV currently supports browsing both subreddits and individual submissions. In each mode the controls are slightly different. + +--------------- +Global Commands +--------------- + +:``▲``/``▼`` or ``j``/``k``: Scroll to the prev/next item +:``a``/``z``: Upvote/downvote the selected item +:``ENTER`` or ``o``: Open the selected item in the default web browser +:``r``: Refresh the current page +:``u``: Login and logout of your user account +:``?``: Show the help screen +:``q``: Quit + +-------------- +Subreddit Mode +-------------- + +In subreddit mode you can browse through the top submissions on either the front page or a specific subreddit. + +:``►`` or ``l``: View comments for the selected submission +:``/``: Open a prompt to switch subreddits +:``f``: Open a prompt to search the current subreddit +:``p``: Post a new submission to the current subreddit + +The ``/`` prompt accepts subreddits in the following formats + +* ``/r/python`` +* ``/r/python/new`` +* ``/r/python+linux`` supports multireddits +* ``/r/front`` will redirect to the front page +* ``/r/me`` will display your submissions + +--------------- +Submission Mode +--------------- + +In submission mode you can view the self text for a submission and browse comments. + +:``◄`` or ``h``: Return to subreddit mode +:``►`` or ``l``: Fold the selected comment, or load additional comments +:``c``: Post a new comment on the selected item + + +========= +Changelog +========= +Please see `CHANGELOG.rst `_. + + +============ +Contributors +============ +Please see `CONTRIBUTORS.rst `_. + + +======= +License +======= +Please see `LICENSE `_. + + +.. |python| image:: https://pypip.in/py_versions/rtv/badge.svg?style=flat + :target: https://pypi.python.org/pypi/rtv/ + :alt: Supported Python versions + +.. |pypi| image:: https://pypip.in/version/rtv/badge.svg?text=version&style=flat + :target: https://pypi.python.org/pypi/rtv/ + :alt: Latest Version