You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+6-4Lines changed: 6 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,24 +17,26 @@ This repo includes:
17
17
## Usage
18
18
19
19
> [!WARNING]\
20
-
This project uses `pnpm` by default, and utilizes `pnpm workspaces`. If you do not have `pnpm` installed, you can install it with `npm install -g pnpm`.
20
+
> This project uses `pnpm` by default, and utilizes `pnpm workspaces`. If you do not have `pnpm` installed, you can install it with `npm install -g pnpm`.
21
21
22
22
You _can_ use `yarn` or `npm`, however, _you_ will need to modify the project to remove the `pnpm` specific commands and workspace.
23
23
24
24
## Setup
25
+
25
26
### Step 1 - setup node environment
26
27
27
28
```bash
28
29
pnpm run setup
29
30
```
31
+
30
32
### Step 2 - setting up the backend binary
31
33
32
34
To actually compile the project, you'll also need a binary of the ETVR backend from [here]().
33
35
34
-
Clone the project, follow its readme to set it up and build the binary.
36
+
Clone the project, follow its readme to set it up and build the binary.
35
37
Once done, copy the result into [backend_bin](/src-tauri/backend_bin) and rename it to `ETVR-<target-triple>`
36
38
37
-
The target triple can be obtained by running
39
+
The target triple can be obtained by running
38
40
39
41
```bash
40
42
rustc -Vv
@@ -77,7 +79,7 @@ Uses `Prettier` and the above `pnpm lint` command to lint and then format all in
77
79
78
80
## Development
79
81
80
-
This project follows the architecture Tauri laid down - `Tauri Plugins` and commands, to communicate with the hardware.
82
+
This project follows the architecture Tauri laid down - `Tauri Plugins` and commands, to communicate with the hardware.
81
83
These plugins are located in the [`src-tauri/src/lib`](/src-tauri/src/lib) folder.
0 commit comments