Skip to content

Commit 85e1f65

Browse files
committed
some more install work
1 parent f900f7a commit 85e1f65

File tree

1 file changed

+39
-5
lines changed

1 file changed

+39
-5
lines changed

README.md

Lines changed: 39 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
> _This project is still maturing, but you are welcome to check it out, leave feedback and/or a PR_
66
7-
Quick Links: **[Installation](./Installation.ipynb) | [Configuring](./docs/Configuring.ipynb) | [Updating](#updating) | [Changelog](./CHANGELOG.md) | [Roadmap](./docs/Roadmap.ipynb) | [Contributing](./CONTRIBUTING.md) | [Extending](./docs/Extending.ipynb)**
7+
Quick Links: **[Installation](#installation) | [Configuring](./docs/Configuring.ipynb) | [Updating](#updating) | [Changelog](./CHANGELOG.md) | [Roadmap](./docs/Roadmap.ipynb) | [Contributing](./CONTRIBUTING.md) | [Extending](./docs/Extending.ipynb)**
88

99
## Features
1010

@@ -78,26 +78,60 @@ Either:
7878

7979
- JupyterLab >=1.1.4,<1.2
8080
- JupyterLab >=1.2.4,<1.3.0a0
81+
82+
And:
83+
8184
- Python 3.5+
8285
- nodejs 8+
8386

8487
## Installation
8588

86-
For the current stable version:
89+
> For more extensive installation instructions, see the [documentation](./docs/Installation.ipynb).
90+
91+
For the current stable version, the following steps are recommended.
92+
Use of a python `virtualenv` or a conda env is also recommended.
93+
94+
1. install python 3
95+
96+
```bash
97+
conda install -c conda-forge python=3
98+
# or
99+
conda install -c conda-forge jupyterlab=1.2
100+
```
101+
102+
1. install JupyterLab
103+
104+
```bash
105+
conda install -c conda-forge jupyterlab=1.2
106+
# or
107+
pip install jupyterlab=1.2
108+
```
87109

88110
1. install the server extension:
89111

90112
```bash
91113
pip install --pre jupyter-lsp
92114
```
93115

94-
2. install the frontend extension:
116+
1. install `nodejs`
117+
118+
```bash
119+
conda install -c conda-forge nodejs
120+
# or one of the following, as an administrator
121+
choco install nodejs # Windows with Chocolatey
122+
sudo apt-get install nodejs # Debian/Ubuntu
123+
sudo brew install nodejs # MacOS with Homebrew
124+
sudo dnf install nodejs # Fedora
125+
sudo yum install nodejs # RHEL/CentOS
126+
```
127+
128+
1. install the frontend extension:
95129

96130
```bash
97131
jupyter labextension install @krassowski/jupyterlab-lsp
98132
```
99133

100-
3. install LSP servers for languages of your choice; for example, for Python
134+
1. install LSP servers for languages of your choice; for example, for Python
101135
([pyls](https://github.com/palantir/python-language-server)) and
102136
R ([languageserver](https://github.com/REditorSupport/languageserver)) servers:
103137

@@ -122,7 +156,7 @@ For the current stable version:
122156
Note: it may be worth visiting the repository of each server you install as
123157
many provide additional configuration options.
124158

125-
4. (Optional, Linux/OSX-only) to enable opening files outside of the root
159+
1. (Optional, Linux/OSX-only) to enable opening files outside of the root
126160
directory (the place where you start JupyterLab), create `.lsp_symlink` and
127161
symlink your `/home`, or any other location which includes the files that you
128162
wish to make possible to open in there:

0 commit comments

Comments
 (0)