Skip to content
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

Update README.md to include Deno setup and usage instructions #5

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update README.md to include Deno setup and usage instructions #5

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 24 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,21 @@ JavaScript code, how to trigger react to callbacks, get and set properties and u

In order to use this template and build a Node.js application, you need to install a few tools:

* **[Rust compiler](https://www.rust-lang.org/tools/install)** (1.70 or newer)

If you use Node.js:

* **[Node.js](https://nodejs.org/download/release/)** (v16. or newer)
* **[npm](https://www.npmjs.com/)**
* **[Rust compiler](https://www.rust-lang.org/tools/install)** (1.70 or newer)

If you use Deno:

* **[Deno](https://deno.com/)**

## Usage

### Using Node.js

1. Clone or download this repository
```
git clone https://github.com/slint-ui/slint-nodejs-template my-project
Expand All @@ -32,6 +41,20 @@ In order to use this template and build a Node.js application, you need to insta
npm start
```

### Using Deno

1. Clone or download this repository
```
git clone https://github.com/slint-ui/slint-nodejs-template my-project
cd my-project
```
2. Run the application binary
```
deno run --allow-read --allow-ffi src/main.js
```

### Additional information

We recommend using an IDE for development, along with our [LSP-based IDE integration for `.slint` files](https://github.com/slint-ui/slint/blob/master/tools/lsp/README.md). You can also load this project directly in [Visual Studio Code](https://code.visualstudio.com) and install our [Slint extension](https://marketplace.visualstudio.com/items?itemName=Slint.slint).

## Next Steps
Expand Down