gryf/tuir
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

complete refactor of readme into separate files, yay for documentation! 🎆

Browse Source
This commit is contained in:
Tobin
2015-04-06 00:13:06 -05:00
parent f60e85ef54
commit 446e55b727
3 changed files with 109 additions and 60 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
CHANGELOG.rst Normal file
View File

@@ -0,0 +1,36 @@
=============
RTV Changelog
=============
-----
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.

23
CONTRIBUTORS.rst Normal file
View File

@@ -0,0 +1,23 @@
================
RTV Contributors
================
Thanks to the following people for their contributions to this project.
* `michael-lazar <http://github.com/michael-lazar>`_
* `Tobin Brown <http://github.com/Brobin>`_
* `Yusuke Sakamoto <http://github.com/yskmt>`_
* `Noah Morrison <http://github.com/noahmorrison>`_
* `Toby Hughes <http://github.com/tobywhughes>`_
* `Shawn Hind <http://github.com/shanhind>`_
* `mekhami <http://github.com/mekhami>`_
* `JuanPablo <http://github.com/juanpabloaj>`_
* `Robert Greener <http://github.com/ragreener1>`_
* `Hans Roman <http://github.com/snahor>`_
* `peterpans01 <http://github.com/peterpans01>`_
* `Ram-Z <http://github.com/Ram-Z>`_
* `Marc Abramowitz <http://github.com/msabramo>`_
* `Adam Talsma <http://github.com/a-tal>`_
* `Wieland Hoffmann <http://github.com/mineo>`_
* `Thomas Kajder <http://github.com/tkajder>`_

110
README.rst
View File

@@ -1,37 +1,31 @@
.. 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/ RTV: Reddit Terminal Viewer
:alt: Supported Python versions ===========================
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.
======================
Reddit Terminal Viewer
======================
Browse Reddit from your terminal
1. `Overview`_
2. `Installation`_
3. `Configuration`_
4. `Usage`_
5. `Changelog`_
--------
Overview
--------
.. image:: http://i.imgur.com/W1hxqCt.png .. 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.
---------------
|pypi| |python|
---------------
------------ * `Installation`_
* `Configuration`_
* `Usage`_
* `Global Commands`_
* `Subreddit Mode`_
* `Submission Mode`_
* `Changelog`_
* `Contributors`_
* `License`_
============
Installation Installation
------------ ============
Install using pip Install using pip
@@ -55,9 +49,9 @@ The installation will place a script in the system path
$ rtv --help $ rtv --help
------------- =============
Configuration 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. 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. This can be used to avoid having to re-enter login credentials every time the program is launched.
@@ -92,13 +86,15 @@ Set the environment variable ``RTV_EDITOR`` to specify which editor the program
$ export RTV_EDITOR=gedit $ export RTV_EDITOR=gedit
----- =====
Usage Usage
----- =====
RTV currently supports browsing both subreddits and individual submissions. In each mode the controls are slightly different. RTV currently supports browsing both subreddits and individual submissions. In each mode the controls are slightly different.
**Global Commands** ---------------
Global Commands
---------------
:``▲``/``▼`` or ``j``/``k``: Scroll to the prev/next item :``▲``/``▼`` or ``j``/``k``: Scroll to the prev/next item
:``a``/``z``: Upvote/downvote the selected item :``a``/``z``: Upvote/downvote the selected item
@@ -108,7 +104,9 @@ RTV currently supports browsing both subreddits and individual submissions. In e
:``?``: Show the help screen :``?``: Show the help screen
:``q``: Quit :``q``: Quit
**Subreddit Mode** --------------
Subreddit Mode
--------------
In subreddit mode you can browse through the top submissions on either the front page or a specific subreddit. In subreddit mode you can browse through the top submissions on either the front page or a specific subreddit.
@@ -125,7 +123,9 @@ The ``/`` prompt accepts subreddits in the following formats
* ``/r/front`` will redirect to the front page * ``/r/front`` will redirect to the front page
* ``/r/me`` will display your submissions * ``/r/me`` will display your submissions
**Submission Mode** ---------------
Submission Mode
---------------
In submission mode you can view the self text for a submission and browse comments. In submission mode you can view the self text for a submission and browse comments.
@@ -137,35 +137,25 @@ In submission mode you can view the self text for a submission and browse commen
========= =========
Changelog Changelog
========= =========
.. _@michael-lazar: http://github.com/michael-lazar Please see `CHANGELOG.rst <https://github.com/michael-lazar/rtv/blob/master/CHANGELOG.rst>`_.
.. _@Brobin: http://github.com/Brobin
.. _@yskmt: http://github.com/yskmt
.. _@Ram-Z: http://github.com/Ram-Z
.. _@a-tal: http://github.com/a-tal
---
1.2
---
Features
* Added user login / logout with the `u` key. `@yskmt`_ ============
* Added subreddit searching with the `f` key. `@Brobin`_ Contributors
* Added submission posting with the `p` key. `@Brobin`_ ============
* Added viewing of user submissions with `/r/me`. `@Brobin`_ Please see `CONTRIBUTORS.rst <https://github.com/michael-lazar/rtv/blob/master/CONTRIBUTORS.rst>`_.
* Program title now displays in the terminal window. `@Brobin`_
* Gold symbols now display on guilded comments and posts. `@Brobin`_
* Moved default config location to XDG_CONFIG_HOME. `@Ram-Z`_
Bugfixes
* Improved error handling for submission / comment posts. `@michael-lazar`_ =======
* Fixed handling of unicode flairs. `@michael-lazar`_ License
* Improved displaying of the help message and selfposts on small terminal windows. `@michael-lazar`_ =======
* The author's name now correctly highlights in submissions `@Brobin`_ Please see `LICENSE <https://github.com/michael-lazar/rtv/blob/master/LICENSE>`_.
* Corrected user agent formatting. `@a-tal`_
* Various minor bugfixes. `@michael-lazar`_
---
1.1 .. |python| image:: https://pypip.in/py_versions/rtv/badge.svg?style=flat
--- :target: https://pypi.python.org/pypi/rtv/
* Post comments using your text editor. :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