Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
25 changes: 14 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,32 @@
# Setup

This guide explains how to set up and build the node-win project.

---
This guide explains how to set up and build the `node-win` project.

## Prerequisites

Before proceeding, ensure you have the following tools installed:

```markdown
- Python 3.10 (configured correctly).
- Node.js and yarn.
- node-gyp (global installation):
- **Python 3.10**
- **Node 18**

```bash
nvm install 18
```

- **yarn**

```bash
npm install -g yarn
```

- **node-gyp**

```bash
npm install -g node-gyp
```

- **Visual Studio** (not VS Code) for building native dependencies.

---

## Build Steps

Run the following command to build the project:
Expand All @@ -31,5 +36,3 @@ npm run build
```

This step compiles the necessary native bindings.

---
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@internxt/node-win",
"version": "1.0.1",
"version": "1.0.4",
"description": "Drive desktop node addon",
"main": "dist/index.ts",
"types": "dist/index.d.ts",
Expand Down