Skip to content

Commit

Permalink
improve quickstart
Browse files Browse the repository at this point in the history
  • Loading branch information
Xenepix committed Jan 5, 2024
1 parent 2bc3704 commit 50da204
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 23 deletions.
1 change: 0 additions & 1 deletion .github/workflows/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ on:
push:
branches:
- main
- docs

permissions:
contents: write
Expand Down
63 changes: 41 additions & 22 deletions docs/sources/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,43 +18,62 @@ Napse is still in early stage. You can only run it manually for now.

To install nvm, download and install the nvm script from the project's GitHub page:

```shell
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.38.0/install.sh | bash
```

After installing nvm, close your terminal and open a new one. Verify the installation by checking the version of nvm:
=== "Linux"

```shell
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.38.0/install.sh | bash
nvm --version
```

=== "MacOS"

Please follow this [tutorial](https://dev.to/csituma/install-nvm-on-mac-windows-and-linux-1aj9)

=== "Windows"

Please follow this [tutorial](https://dev.to/csituma/install-nvm-on-mac-windows-and-linux-1aj9)

```shell
nvm --version
```

### Install Node.js

Now, you can install Node.js. The following command installs Node.js latest version :

```shell
nvm install --lts
```
=== "Linux"

```shell
nvm install --lts
```

=== "MacOS"

Please follow this [tutorial](https://radixweb.com/blog/installing-npm-and-nodejs-on-windows-and-mac)

=== "Windows"

Please follow this [tutorial](https://radixweb.com/blog/installing-npm-and-nodejs-on-windows-and-mac)

### Install yarn

Yarn is a Node package manager. Install it by running these commands

```shell
curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | sudo apt-key add -
```

```shell
echo "deb https://dl.yarnpkg.com/debian/ stable main" | sudo tee /etc/apt/sources.list.d/yarn.list
```
=== "Linux"

```shell
sudo apt update
```
```shell
curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | sudo apt-key add -
echo "deb https://dl.yarnpkg.com/debian/ stable main" | sudo tee /etc/apt/sources.list.d/yarn.list
sudo apt update
sudo apt install yarn
```

```shell
sudo apt install yarn
```
=== "MacOS"

Please follow this [tutorial](https://www.hostinger.com/tutorials/how-to-install-yarn)

=== "Windows"

Please follow this [tutorial](https://www.hostinger.com/tutorials/how-to-install-yarn)

---
## Run the desktop application
Expand Down

0 comments on commit 50da204

Please sign in to comment.