dragonwocky/notion-enhancer
1
0
Fork 0
mirror of https://github.com/notion-enhancer/notion-enhancer.git synced 2025-04-04 04:39:03 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: README installation clarification (#189)

Browse Source 
* docs: Fixed link to dev build instructions

* docs: README installation clarification

* docs: README installation clarification

* update windows keystroke for task manager

* More README alterations

* Add bullet condensing & bullet lines tweaks

Co-authored-by: Tom <thedragonring.bod@gmail.com>
This commit is contained in:
Alexa B 2020-11-03 06:45:40 -05:00 committed by GitHub
parent 74b3bd4b52
commit b671451261
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 30 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

65
README.md
View File

@ -28,42 +28,37 @@ a chrome extension may be coming soon for web client support.
## installation
> coming from <= v0.7.0? things are a bit different - have a read of [the update guide](UPDATING.md)
> before following these instructions.
> **if you are updating from v0.7.0,** things have changed, more information is available
> 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:
```
sudo chmod -R a+wr /usr/local/lib/node_modules
sudo chmod -R a+wr /usr/local/bin
sudo chmod -R a+wr /Applications/Notion.app/Contents/Resources
npm i -g notion-enhancer
```
**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 -
sudo apt-get install -y nodejs
npm i -g notion-enhancer
```
**arch linux, manjaro**
install the [aur package](https://aur.archlinux.org/packages/notion-enhancer)
with your aur helper (e.g. `yay -S notion-enhancer`).
- ensure that no notion windows/processes are running by ending all Notion processes in your task manager.
- `CMD + ALT + ESC` on mac and `CTRL + SHIFT + ESC` 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 aside from downloading to install notion-enhancer
- 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) based on your operating system, if there are multiple lines, make sure to enter them *one by one*
- **windows 10:**
```
npm i -g notion-enhancer
```
- **mac:** This may ask you to enter your password, instead of hiding your password with *** symbols, mac terminal hides it by making it invisible. Simply type your password and click enter.
```
sudo chmod -R a+wr /usr/local/lib/node_modules
sudo chmod -R a+wr /usr/local/bin
sudo chmod -R a+wr /Applications/Notion.app/Contents/Resources
npm i -g notion-enhancer
```
- **debian/ubuntu, chromeOS, WSL (to modify the win10 app):**
```
bash curl -sL https://deb.nodesource.com setup_current.x | sudo -E bash -
sudo apt-get install -y nodejs
npm i -g notion-enhancer
```
- **arch linux, manjaro:**
- install the [aur package](https://aur.archlinux.org/packages/notion-enhancer) with your aur helper (e.g. `yay -S notion-enhancer`).
### command-line interface