From d46c572dc30c1ed90a7f8d08d8492b4dbe9816f4 Mon Sep 17 00:00:00 2001 From: Sang Han Date: Sun, 7 Dec 2014 22:12:18 -0800 Subject: [PATCH] updated documentation --- README.rst | 23 ++++++++++++----------- 1 file changed, 12 insertions(+), 11 deletions(-) diff --git a/README.rst b/README.rst index 2b3136a..60e1458 100644 --- a/README.rst +++ b/README.rst @@ -1,3 +1,4 @@ +============ py-translate ============ @@ -8,7 +9,6 @@ A simple translation command line utility .. figure:: https://raw.githubusercontent.com/jjangsangy/py-translate/master/img/alice.gif :alt: Translate Lewis Carroll: Alice in Wonderland - Translate Lewis Carroll: Alice in Wonderland The end goal is a simple application for translating text in the terminal. Text can be generated interactively or programmatically in the shell environment. Through command line arguments, file descriptors or @@ -31,7 +31,7 @@ Installation From PyPI with pip (easy) ~~~~~~~~~~~~~~~~~~~~~~~~~ -.. code:: sh +.. code-block:: sh $ pip install py-translate @@ -40,13 +40,13 @@ From Source at Github - Clone the repository -.. code:: sh +.. code-block:: sh $ git clone https://github.com/jjangsangy/py-translate.git - Install with setup.py -.. code:: sh +.. code-block:: sh $ python setup.py install @@ -82,7 +82,7 @@ Examples - Default will translate from english to target language -.. code:: sh +.. code-block:: sh $ translate zh-TW <<< 'Hello World!' 你好世界! @@ -90,12 +90,10 @@ Examples .. figure:: https://raw.githubusercontent.com/jjangsangy/py-translate/master/img/helloworld.gif :alt: Hello World - Hello World - - Just as easily specify a source language by providing it as first argument -.. code:: sh +.. code-block:: sh # Translate Hello from French to English $ translate fr en <<< 'Bonjour, comment allez-vous!' @@ -104,7 +102,7 @@ Examples Redirect from File ~~~~~~~~~~~~~~~~~~ -.. code:: sh +.. code-block:: sh $ translate zh-TW < 'alice.txt' @@ -121,7 +119,7 @@ Redirect from File Chaining together Pipes ~~~~~~~~~~~~~~~~~~~~~~~ -.. code:: sh +.. code-block:: sh # Multiple Chaining $ echo 'What is love?' | translate zh-TW | translate zh-TW ko | translate ko fr | translate fr en @@ -130,7 +128,7 @@ Chaining together Pipes Be Creative! ~~~~~~~~~~~~ -.. code:: sh +.. code-block:: sh # Grocery List $ cat << BUY | translate ko @@ -154,9 +152,12 @@ Find the latest documentation http://pythonhosted.org//py-translate/ .. |Documentation Status| image:: https://readthedocs.org/projects/py-translate/badge/?version=master :target: https://readthedocs.org/projects/py-translate/?badge=master + .. |github| image:: https://badge.fury.io/gh/jjangsangy%2Fpy-translate.svg :target: http://badge.fury.io/gh/jjangsangy%2Fpy-translate + .. |travis| image:: https://travis-ci.org/jjangsangy/py-translate.svg?branch=master :target: https://travis-ci.org/jjangsangy/py-translate + .. |pypi| image:: https://badge.fury.io/py/py-translate.svg :target: http://badge.fury.io/py/py-translate