diff --git a/README.rst b/README.rst index dd307d33..594e1720 100644 --- a/README.rst +++ b/README.rst @@ -12,10 +12,20 @@ bpython: A fancy interface to the Python interactive interpreter **************************************************************** -`bpython`_ is a lightweight Python interpreter that adds several features common -to IDEs. These features include **syntax highlighting**, **expected parameter -list**, **auto-indentation**, and **autocompletion**. (See below for example -usage). +**Introduction:** +bpython is a lightweight Python interpreter with added features commonly found in integrated development environments (IDEs). These features include syntax highlighting, auto-indentation, autocompletion, and displaying expected parameter lists for functions. + +**Features:** +- Autocomplete suggestions as you type (similar to Readline). +- In-line syntax highlighting using Pygments. +- Display of expected parameter lists for functions. +- Rewind function to re-evaluate and edit previous code. +- Open current session in an external text editor. +- Paste code to pastebin or write to a file. +- Reload imported Python modules to test changes. + +**Usage:** +bpython is not a full IDE but a practical and lightweight solution. It's ideal for testing code, helping others on IRC, or quick experimentation. .. image:: https://bpython-interpreter.org/images/math.gif :alt: bpython @@ -38,19 +48,22 @@ You can find more about bpython - including `full documentation`_ - at our Installation & Basic Usage ========================== -Installation using Pip ----------------------- - -If you have `pip`_ installed, you can simply run: - -.. code-block:: bash - - $ pip install bpython - -Start bpython by typing ``bpython`` in your terminal. You can exit bpython by -using the ``exit()`` command or by pressing control-D like regular interactive -Python. - +**Installation:** +Using Pip: +If you have pip installed, run: `$ pip install bpython` +Start bpython by typing `bpython` in the terminal. Exit with `exit()` or `ctrl-D`. + +**Dependencies:** +- Pygments +- curtsies >= 0.4.0 +- greenlet +- pyxdg +- requests +- Sphinx >= 1.5 (optional, for documentation) +- babel (optional, for internationalization) +- jedi (optional, for multiline completion) +- watchdog (optional, for monitoring module changes) +- pyperclip (optional, for clipboard copying) =================== Features & Examples =================== @@ -78,6 +91,8 @@ Features & Examples * Reload imported Python modules. Use to clear sys.modules and rerun your session to test changes to code in a module you're working on. + + ============= Configuration ============= @@ -87,19 +102,7 @@ your config file as **~/.config/bpython/config** (i.e. bpython --config /path/to/bpython/config -============ -Dependencies -============ -* Pygments -* curtsies >= 0.4.0 -* greenlet -* pyxdg -* requests -* Sphinx >= 1.5 (optional, for the documentation) -* babel (optional, for internationalization) -* jedi (optional, for experimental multiline completion) -* watchdog (optional, for monitoring imported modules for changes) -* pyperclip (optional, for copying to the clipboard) + bpython-urwid -------------