diff --git a/README.rst b/README.rst index cb1d26a..e86d113 100644 --- a/README.rst +++ b/README.rst @@ -167,7 +167,21 @@ Why am I getting an error during installation/when launching rtv? $ sudo pip uninstall rtv $ sudo pip3 install -U rtv -How do I run the repository code directly? +Why do I see garbled text like ``M-b~@M-"`` or ``^@``? + Short answer + Start rtv in ascii-only mode with ``rtv --ascii`` + + Long answer + This type of text usually shows up when python is unable to render + unicode properly. + + 1. Make sure that the terminal/font that you're using supports unicode + 2. Try `setting the LOCALE to utf-8 `_ + 3. Your python may have been built against the wrong curses library, + see `here `_ and + `here `_ 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 in order to resolve imports you need to launch using python's ``-m`` flag. This method works for all versions of python. See the example below, which