aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorjdhao <jdhao@hotmail.com>2021-08-06 00:20:55 +0800
committerjdhao <jdhao@hotmail.com>2021-08-06 00:22:32 +0800
commit0830dfcf90dc708330730808f2fd67f5b7f46ef3 (patch)
tree21ca46dcdd9433ba523e3d2bded18d7fdada3207
parent0283382f6e91216fd23ef5af4b26d08b3ee4eee0 (diff)
Add installation script for Windows, update doc
-rw-r--r--docs/README.md13
-rw-r--r--docs/nvim_setup_windows.ps129
2 files changed, 38 insertions, 4 deletions
diff --git a/docs/README.md b/docs/README.md
index ff62731..77bdc27 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -7,8 +7,8 @@ and development work.
A lot of Neovim plugins are mainly written in Python. To use auto-completion
and other features, we must install Python 3. The easiest way to install is via
-[Anaconda](https://www.anaconda.com/distribution/#download-section) or [Miniconda](https://docs.conda.io/en/latest/miniconda.html). Make sure that the
-output of `python --version` shows that Python 3.x is installed.
+[Anaconda](https://www.anaconda.com/distribution/#download-section) or[Miniconda](https://docs.conda.io/en/latest/miniconda.html). Make sure that you
+can run `python --version`, and that the output should be Python 3.x.
## Pynvim
@@ -130,13 +130,14 @@ listed [here](https://github.com/dense-analysis/ale/blob/master/supported-tools.
Which [terminal emulator](https://en.wikipedia.org/wiki/Terminal_emulator) we
choose to use greatly affects the appearance and functionalities of Neovim.
Since Neovim supports true colors, terminals that support true colors are
-preferred. For a list of terminals that support true colors, see
-[here](https://github.com/termstandard/colors).
+preferred. For a list of terminals that support true colors, see [here](https://github.com/termstandard/colors).
For macOS, we can use [iterm2](https://www.iterm2.com/), [kitty](https://sw.kovidgoyal.net/kitty/) or [Alacritty](https://github.com/jwilm/alacritty).
If you connect to Linux server on Windows, I recommend [wsltty](https://github.com/mintty/wsltty) and
[Cygwin](https://www.cygwin.com/), both of them use [mintty](https://github.com/mintty/mintty) as the terminal emulator.
+For Windows 10, you can use the new [Windows Terminal](https://github.com/microsoft/terminal).
+
## Font
Since [Vim-airline](https://github.com/vim-airline/vim-airline) uses several
@@ -235,4 +236,8 @@ Note that the variable `PYTHON_INSTALLED`, `SYSTEM_PYTHON` and
`ADD_TO_SYSTEM_PATH` in the script should be set properly based on your
environment.
+# Automatic installation for Windows
+
+Run script [nvim_setup_windows.ps1](nvim_setup_windows.ps1) under PowerShell.
+
[^1]: Use `echo %userprofile%` to see where your `$HOME` is.
diff --git a/docs/nvim_setup_windows.ps1 b/docs/nvim_setup_windows.ps1
new file mode 100644
index 0000000..49ff94a
--- /dev/null
+++ b/docs/nvim_setup_windows.ps1
@@ -0,0 +1,29 @@
+# Install scoop
+Set-ExecutionPolicy RemoteSigned -scope CurrentUser
+iwr -useb get.scoop.sh | iex
+
+# Install node
+scoop install nodejs
+
+# Install ripgrep
+scoop install ripgrep
+
+# Install universal-ctags
+scoop bucket add extras
+scoop install universal-ctags
+
+# Install vim-language-server
+npm install -g vim-language-server
+
+# Install miniconda3
+scoop install miniconda3
+
+# Install pynvim
+pip install -U pynvim
+
+# Install python-language-server
+pip install 'python-lsp-server[all]' pylsp-mypy pyls-isort
+
+# Install neovim nightly
+scoop bucket add versions
+scoop install neovim-nightly