Skip to content

Updated README file #23

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
KrAG2000 wants to merge 2 commits into
base: dev
Choose a base branch
from
Open

Updated README file #23

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9223d03
Merge pull request #19 from forgexfoundation/dev
xanmoy Aug 28, 2025
2c7575e
README Changes only!
krag-fragmatic Nov 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 31 additions & 17 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Notion Desktop is a cross-platform desktop application that allows you to use Notion directly on your computer, making it easier to chat with friends and family while working.

![Image](https://github.com/xanmoy/notion-desktop/blob/main/screenshots/notion-desktop.jpeg)
![Image](https://github.com/xanmoy/notion-desktop/blob/main/screenshots/notion-desktop.jpeg?raw=true)

## 🛠 **Features**

Expand All @@ -15,7 +15,7 @@ Notion Desktop is a cross-platform desktop application that allows you to use No

---

![Image](https://github.com/xanmoy/notion-desktop/blob/main/screenshots/image1.png)
![Image](https://github.com/xanmoy/notion-desktop/blob/main/screenshots/image1.png?raw=true)

## 📦 **Installation**

Expand All @@ -25,56 +25,70 @@ sudo snap install notion-desktop

### Build From Source

1. **Clone the repository**:
#### 1. **Clone the repository**:

```bash
git clone https://github.com/xanmoy/notion-desktop.git
cd notion-desktop
git clone https://github.com/xanmoy/notion-desktop.git
cd notion-desktop
```

2. **Install dependencies**: Ensure that you have all the necessary dependencies installed.
#### 2. **Install dependencies**: Ensure that you have all the necessary dependencies installed.

```bash
npm instal
npm install
```

3. Start the application:
#### 3. **Start the application**:

```bash
npm start
npm start
```

4. **Build the application**: Run the following command to create a Snap package of the application.
#### 4. **Build the application**:

Run **one** of the following commands depending on the package format you want to generate:

##### **Snap package**

```bash
npm run dist
npm run dist:snap
```

5. **Change to the dist directory**: Navigate to the dist directory where the Snap package is located.
**OR**

##### **AppImage package** ([What are AppImages?](https://appimage.org/))

```bash
npm run dist:appimage
```

#### 5. Change to the dist directory

Navigate to the directory where the generated package (Snap or AppImage) is located:

```bash
cd dist
cd dist
```

6. **Install the Snap package**: Use the following command to install the Snap package. The `--dangerous` flag allows the installation of locally built packages.
#### 6. **Install the Snap package**: Use the following command to install the Snap package. The `--dangerous` flag allows the installation of locally built packages.

```bash
sudo snap install --dangerous ./Notion-desktop_1.0.3_amd64.snap
sudo snap install --dangerous ./notion-desktop_1.2.0_amd64.snap
```

## ↩️ **Uninstallation Steps**

Remove the Snap package: To uninstall the Notion Desktop application, run the following command:

```bash
sudo snap remove Notion-desktop
sudo snap remove notion-desktop
```

## 📖 **Usage Instructions**

### **Launching the App**:

After installation, open Notion Desktop using:
After installation, open Notion Desktop using:

```bash
notion-desktop
Expand Down