From 5add18becb57d241e39ee19eb69123ca80674b2a Mon Sep 17 00:00:00 2001 From: Michael Lazar Date: Thu, 21 Sep 2017 11:27:50 -0400 Subject: [PATCH] Update README.md --- README.md | 71 ++++++++++++++++++++++++++++++------------------------- 1 file changed, 39 insertions(+), 32 deletions(-) diff --git a/README.md b/README.md index 8390bf8..2f3d46e 100644 --- a/README.md +++ b/README.md @@ -170,41 +170,48 @@ On Linux systems you will need to install either [xsel](http://www.vergenet.net/ ## FAQ -**Why am I getting an error during installation/when launching rtv?** +
+ Why am I getting an error during installation/when launching rtv? + + > If your distro ships with an older version of python 2.7 or python-requests, + > you may experience SSL errors or other package incompatibilities. The + > easiest way to fix this is to install rtv using python 3. If you + > don't already have pip3, see http://stackoverflow.com/a/6587528 for setup + > instructions. Then do + > + > ```bash + > $ sudo pip uninstall rtv + > $ sudo pip3 install -U rtv + > ``` -> If your distro ships with an older version of python 2.7 or python-requests, -> you may experience SSL errors or other package incompatibilities. The -> easiest way to fix this is to install rtv using python 3. If you -> don't already have pip3, see http://stackoverflow.com/a/6587528 for setup -> instructions. Then do -> -> ```bash -> $ sudo pip uninstall rtv -> $ sudo pip3 install -U rtv -> ``` +
+
+ Why do I see garbled text like M-b~@M-" or ^@? + + > This type of text usually shows up when python is unable to render + > unicode properly. + > + > 1. Try starting RTV in ascii-only mode with ``rtv --ascii`` + > 2. Make sure that the terminal/font that you're using supports unicode + > 3. Try [setting the LOCALE to utf-8](https://perlgeek.de/en/article/set-up-a-clean-utf8-environment) + > 4. Your python may have been built against the wrong curses library, + > see [here](stackoverflow.com/questions/19373027) and + > [here](https://bugs.python.org/issue4787) for more information -**Why do I see garbled text like** ``M-b~@M-"`` **or** ``^@`` **?** +
+
+ How do I run the code directly from the repository? + + > This project is structured to be run as a python *module*. This means that + > you need to launch it using python's ``-m`` flag. See the example below, which + > assumes that you have cloned the repository into the directory **~/rtv_project**. + > + > ```bash + > $ cd ~/rtv_project + > $ python3 -m rtv + > ``` -> This type of text usually shows up when python is unable to render -> unicode properly. -> -> 1. Try starting RTV in ascii-only mode with ``rtv --ascii`` -> 2. Make sure that the terminal/font that you're using supports unicode -> 3. Try [setting the LOCALE to utf-8](https://perlgeek.de/en/article/set-up-a-clean-utf8-environment) -> 4. Your python may have been built against the wrong curses library, -> see [here](stackoverflow.com/questions/19373027) and -> [here](https://bugs.python.org/issue4787) for more information - -**How do I run the code directly from the repository?** - -> This project is structured to be run as a python *module*. This means that -> you need to launch it using python's ``-m`` flag. See the example below, which -> assumes that you have cloned the repository into the directory **~/rtv_project**. -> -> ```bash -> $ cd ~/rtv_project -> $ python3 -m rtv -> ``` +
## Contributing All feedback and suggestions are welcome, just post an issue!