Skip to content

Commit

Permalink
README: improve installation section
Browse files Browse the repository at this point in the history
  • Loading branch information
mhinz committed Feb 28, 2018
1 parent c7f9540 commit 7c6fb5b
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 8 deletions.
6 changes: 3 additions & 3 deletions INSTALLATION.md
@@ -1,6 +1,6 @@
# Installation

#### The normal way
## The normal way

$ pip3 install neovim-remote

Expand All @@ -21,7 +21,7 @@ This will give you the correct location:

$ python3 -c 'import site; print(site.USER_BASE)'

#### From repo
## From repo

If you want to test your own changes, it makes sense to put your local repo into
_develop mode_. That way your Python environment will use the repo directly and
Expand All @@ -33,7 +33,7 @@ you don't have to reinstall the package after each change:

Now, `pip3 list` will show the path to the local repo after the package version.

#### From zip
## From zip

Download the [zipped
sources](https://github.com/mhinz/neovim-remote/archive/master.zip) and install
Expand Down
13 changes: 8 additions & 5 deletions README.md
Expand Up @@ -6,8 +6,8 @@
[![Supported Python versions](https://img.shields.io/pypi/pyversions/neovim-remote.svg)](https://pypi.python.org/pypi/neovim-remote)
[![License](https://img.shields.io/pypi/l/neovim-remote.svg)](https://pypi.python.org/pypi/neovim-remote)

- [Use case](#use-case)
- [Installation](#installation)
- [Use case](#use-case)
- [Usage](#usage)
- [Demos](#demos)
- [FAQ](#faq)
Expand All @@ -33,6 +33,13 @@ If the targeted address does not exist, **nvr** starts a new process by running
"nvim". You can change the command by setting `$NVR_CMD`. _(This requires
forking, so it won't work on Windows.)_

## Installation

$ pip3 install neovim-remote

If you encounter any issues, e.g. permission denied errors or you can't find the
`nvr` executable, read [INSTALLATION.md](INSTALLATION.md).

## Use case

Imagine Neovim is set as your default editor: `EDITOR=nvim`.
Expand All @@ -55,10 +62,6 @@ create a new nvim process. In a terminal buffer, nvr will open a new buffer.

$ git config --global core.editor 'nvr --remote-wait-silent'

## Installation

See [INSTALLATION.md](INSTALLATION.md)

## Usage

Start a nvim process (which acts as a server) in one shell:
Expand Down

0 comments on commit 7c6fb5b

Please sign in to comment.