Added more clear instructions
mellobacon committed
Oct 4, 2022 at 15:25 UTC
2b07fe9188dfa91f678953e85bd1d902c554ea98
1 file changed
+14
-3
CONTRIBUTING.md
+14
-3
@@ -26,15 +26,26 @@ git clone https://github.com/mellobacon/Nucleus.git
26
27
If you want to clone from within your editor, copy ```https://github.com/mellobacon/Nucleus.git``` and follow the instructions for cloning a repo for your editor. Alternatively you can [download the zip file](https://github.com/mellobacon/Nucleus/archive/refs/heads/master.zip).
28
29
+Finally install the packages...
30
+```bash
31
+yarn install # Packages are listed in the package.json
32
+```
33
+
34
## Running Nucleus
35
31
-Once you have the project open, you can run it via a desktop window or alternatively on a browser window*.
36
+First build the app. This will bundle the scripts, css, and other required project files.
37
+```bash
38
+yarn build
39
+```
40
+
41
+Once you have the project built, you can run it via a desktop window or alternatively on a browser window*.
42
33
-\**Nucleus is meant to be run on a desktop window; though it can load and run in a browser*
43
+\**Nucleus is meant to be run on a desktop window. Though it can load and run in a browser, expect weird behavior*
44
45
### To run via a desktop window...
46
47
(*Note on building for desktop: Make sure you have these [prerequisites](https://tauri.app/v1/guides/getting-started/prerequisites) as well as [the Tauri CLI](https://tauri.app/v1/guides/getting-started/tauri-cli)*.)
48
+
49
```bash
50
yarn tauri dev
51
```
@@ -42,7 +53,7 @@ yarn tauri dev
53
### To run via browser...
54
55
```bash
45
-yarn build
56
+yarn build # Will need to be run if there are file changes
57
yarn start
58
```
59