docs: README installation clarification

This commit is contained in:
runargs 2020-11-02 09:13:30 -05:00
parent 8686cb1938
commit 061e1bcd34

View File

@ -28,42 +28,37 @@ a chrome extension may be coming soon for web client support.
## installation ## installation
> coming from <= v0.7.0? things are a bit different - have a read of [the update guide](UPDATING.md) > **if you are updating from v0.7.0,** things have changed, more information is available
> before following these instructions. > in this [update guide](UPDATING.md). please read that before following these instructions.
during installation/removal, make sure no notion processes are running! (check your task manager.)
**win10**
[install node.js](https://nodejs.org/en/download/) (_a computer restart may be required here_),
then execute `npm i -g notion-enhancer` in the command prompt.
**macOS**
[install node.js](https://nodejs.org/en/download/) (_a computer restart may be required here_),
then execute the following lines in the terminal:
- ensure that no notion windows/processes are running by ending all Notion processes in your task manager.
- `CMD + ALT + ESC` on mac and `CTRL + ALT + DEL` on windows/linux to open task manager
- [install node.js](https://nodejs.org/en/download/)
- you may need to restart your computer
- notion-enhancer will use node.js, you do not need to interact with it
- open your computer's terminal, **not Node.js command prompt**
- **windows 10:** search in your start menu (click windows key or icon in bottom left of screen) for *'cmd'* or *'command prompt'*
- **mac:** search in spotlight (magnifying glass in top right of screen) for `*terminal*'
- type and enter the following line(s) one at a time
- **windows 10:**
```
npm i -g notion-enhancer
```
- **mac:**
``` ```
sudo chmod -R a+wr /usr/local/lib/node_modules sudo chmod -R a+wr /usr/local/lib/node_modules
sudo chmod -R a+wr /usr/local/bin sudo chmod -R a+wr /usr/local/bin
sudo chmod -R a+wr /Applications/Notion.app/Contents/Resources sudo chmod -R a+wr /Applications/Notion.app/Contents/Resources
npm i -g notion-enhancer npm i -g notion-enhancer
``` ```
- **debian/ubuntu, chromeOS, WSL (to modify the win10 app):**
**debian/ubuntu, chromeOS, WSL (to modify the win10 app)**
execute the following lines in the terminal:
``` ```
bash curl -sL https://deb.nodesource.com setup_current.x | sudo -E bash - bash curl -sL https://deb.nodesource.com setup_current.x | sudo -E bash -
sudo apt-get install -y nodejs sudo apt-get install -y nodejs
npm i -g notion-enhancer npm i -g notion-enhancer
``` ```
- **arch linux, manjaro:**
**arch linux, manjaro** - install the [aur package](https://aur.archlinux.org/packages/notion-enhancer) with your aur helper (e.g. `yay -S notion-enhancer`).
install the [aur package](https://aur.archlinux.org/packages/notion-enhancer)
with your aur helper (e.g. `yay -S notion-enhancer`).
### command-line interface ### command-line interface