Updating to support Python3

README.md

@@ -0,0 +1,158 @@
+vim-lldb
+========
+
+LLDB debugging in Vim.
+
+
+Installation
+------------
+
+### Using [vim-plug](https://github.com/junegunn/vim-plug)
+
+```vim
+Plug 'lldb-tools/vim-lldb'
+```
+
+### Using [vundle](https://github.com/VundleVim/Vundle.Vim)
+
+```vim
+Plugin 'lldb-tools/vim-lldb'
+```
+
+System Requirements
+-------------------
+
+- Vim 8.2 or above
+- Have [Python or Python 3 support enabled in Vim](#verifying-python-support)*
+
+*Vim can only be compiled with support for a single version of Python. It is recommended to use Python 3 as many Vim plugins only work with Python 3 support in Vim.
+
+vim-lldb Commands
+--------
+
+| Command           | List                                                                    |
+| ---               | ---                                                                     |
+| `:help lldb`      | plugin specific documentation                                           |
+| `:Lhelp`          | LLDB's built-in help system (i.e lldb 'help' command)                   |
+| `:Lscript help (lldb)` | Complete LLDB Python API reference                                |
+| `:L<tab>`         | tab completion through all LLDB commands                                |
+
+
+
+LLDB Commands
+-------------
+
+All LLDB commands are available through `:L<lldb_command>`. Using lldb's documentation at `:Lhelp` along with `:L<tab>` tab completion for all available LLDB commands is a good place to start. Remember to prepend all commands with `:L`.
+For example:
+
+```vim
+" set a target file
+:Ltarget ./path/to/file
+" set a breakpoint under cursor
+:Lbr
+" run debugger
+:Lrun
+" get help for continue command
+:Lhelp continue
+```
+
+Example commands:
+
+
+| Command           | Function                                                                    |
+| ---               | ---                                                                     |
+| `:Ltarget file`   | specify target file                                                     |
+| `:Lsettings set target.input-path <file>` | specify file input (exec < file)                |
+| `:Lbr`            | set breakpoint under cursor                                             |
+| `:Lrun`           | run                                                                     |
+| `:Lstep`          | source level single step in current thread                              |
+| `:Lnext`          | source level single step over in current thread                         |
+| `:Lthread step-in` | instruction level single step in current thread                         |
+| `:Lthread step-over` | instruction level single step-over in current thread                    |
+| `Lcontinue`       | Continue execution of all threads in the current process.               |
+| `:Lfinish`        | step out of currently selected frame                                    |
+| `:Lthread return <RETURN EXPRESSION>`| return immediately from currently selected frame with optional return value |
+| `:Lthread select 1`| select thread 1 as default thread for subsequent commands              |
+| `:Lbt all`         | thread backtrace all                                                   |
+| `:Lfr v`          | show args and local vars for current frame                              |
+| `:Lfr v -f x bar` | show contents of variable `bar` formatted as hex                        |
+| `:Lfr v -f b bar` | same as above with binary formatting                                    |
+| `:Lregister read`  | show the general purpose registers for current thread                  |
+| `:Lregister read rax rsp`  | show the contents of rax, rsp                                  |
+| `:Lregister write rax 123`  | write `123` into rax                                          |
+| `:Ldisassemble --name main` | disassemble any functions named `main`                        |
+| `:Ldisassemble --line` | disassemble current source line for current frame                  |
+| `:Ldisassemble --mixed` | disassemble with mixed mode                                       |
+
+
+
+For a complete list of commands, see [gdb to lldb map](https://lldb.llvm.org/use/map.html)
+
+
+Customization
+-------------
+
+### Global options
+
+
+```vim
+" add custom path to lldb
+let g:lldb_path="/absolute/path/to/lldb"
+```
+
+```vim
+" enable lldb, default is 1 {enable}, 0 {disable}
+let g:lldb_enable = 1
+```
+
+```vim
+" set lldb to async, default is 1 {async}, 0 {sync}
+let g:lldb_async = 1
+```
+
+```vim
+" set lldb console output color
+:hi lldb_output ctermfg=green ctermbg=NONE guifg=green guibg=NONE
+" set breakpoint color
+:hi lldb_breakpoint ctermfg=white ctermbg=DarkGray guifg=white guibg=DarkGray
+```
+
+
+Verifying Python Support
+------------------------
+
+This plugin leverages the `LLDB` module which requires Python support in Vim. Vim's Python version must match `LLDB`'s Python interpreter version exactly.
+
+To verify Vim's Python support, run:
+
+    vim --version | grep python
+
+The output must contain either `+python` or `+python3` indicating support for Python 2 or Python 3, respectively. It is recommended to use Vim compiled with Python 3 as many Vim plugins only support this option.
+
+If Vim warns that it is unable to load vim-lldb on launch, there may be mismatched versions of Python running between `LLDB` and Vim's Python interpreter. Versions must match exactly. To verify Vim's exact Python version, launch Vim and run: 
+
+     :pyx << EOF
+     import sys
+     print(sys.version)
+     EOF
+
+     " verify this version matches lldb's output below
+     3.7.6 (default, ...)
+
+
+
+Verify LLDB's version of Python by launching the Python interpreter in LLDB: 
+
+    $> lldb
+    (lldb) script
+    Python Interactive Interpreter
+    >>> import sys
+    >>> print(svs.version)
+    3.7.6 (default, ...)
+
+
+If Python versions are mismatched, either recompile Vim to match the exact version as LLDB or vice-versa. See [lldb caveats](https://lldb.llvm.org/resources/caveats.html) for details.
+
+See [Customization](#customization) for specifying lldb path in `vimrc`.
+
+