Skip to content
This repository was archived by the owner on Nov 9, 2023. It is now read-only.

Commit 7cceade

Browse files
committed
chore(readme): add install instructions
1 parent be709ef commit 7cceade

File tree

1 file changed

+57
-0
lines changed

1 file changed

+57
-0
lines changed

README.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,60 @@
11
# vue-cli-plugin-tauri
22

33
A Vue CLI plugin for rigging Tauri
4+
5+
## Installation
6+
7+
> Currently not published on npm as it is pre-alpha, but you can test it from git
8+
9+
Prerequisites:
10+
11+
- NodeJS/npm
12+
- Vue CLI (`yarn global add @vue/cli` / `npm i -g @vue/cli`)
13+
- [Rust/Cargo](https://www.rust-lang.org/)
14+
- Tauri CLI (`cargo install tauri-cli`)
15+
- [Yarn](https://yarnpkg.com/lang/en/) (optional but recommended over npm)
16+
17+
Steps:
18+
19+
1. Create a Vue CLI project
20+
21+
```bash
22+
vue create my-tauri-app
23+
cd my-tauri-app
24+
```
25+
26+
2. Install Vue CLI Plugin Tauri
27+
28+
With Yarn:
29+
30+
```bash
31+
yarn add --dev https://github.com/tauri-apps/vue-cli-plugin-tauri
32+
vue invoke tauri
33+
```
34+
35+
With npm:
36+
37+
```bash
38+
npm i --dev https://github.com/tauri-apps/vue-cli-plugin-tauri
39+
vue invoke tauri
40+
```
41+
42+
3. Run commands
43+
44+
With Yarn:
45+
46+
```bash
47+
# Start dev server with HMR
48+
yarn tauri:serve
49+
# Build executable (dist in src-tauri/target/release)
50+
yarn tauri:build
51+
```
52+
53+
With npm:
54+
55+
```bash
56+
# Start dev server with HMR
57+
npm run tauri:serve
58+
# Build executable (dist in src-tauri/target/release)
59+
npm run tauri:build
60+
```

0 commit comments

Comments
 (0)