Create CONTRIBUTING.md
mellobacon committed
Oct 1, 2022 at 21:37 UTC
39af3dc2d3ca3a22ea31448634c877d127b967a3
1 file changed
+69
CONTRIBUTING.md
new
+69
@@ -0,0 +1,69 @@
1
+# Contributing
2
+
3
+Before you get started, please note the following:
4
+
5
+This project was made with [Tauri](https://tauri.app/) and was built with...
6
+- [Svelte](https://svelte.dev/) (Frontend)
7
+- [Rust](https://www.rust-lang.org/) (Backend)
8
+- [TypeScript](https://www.typescriptlang.org/)
9
+
10
+...and these build dependencies...
11
+- [Yarn](https://yarnpkg.com/)
12
+- [Node.js](https://nodejs.org)
13
+
14
+Note that yarn is the package manager I've decided to use for this project and it's what I have Tauri rely on for building the app at the moment. If you want to use another package manager like npm, you can but youll just need to change yarn to npm in the [tauri config](https://github.com/mellobacon/Nucleus/blob/master/src-tauri/tauri.conf.json) and for any command in these instructions that uses yarn.
15
+
16
+## Project Setup
17
+
18
+Clone the repo via...
19
+```bash
20
+gh repo clone mellobacon/Nucleus
21
+```
22
+or
23
+```bash
24
+git clone https://github.com/mellobacon/Nucleus.git
25
+```
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
+## Running Nucleus
30
+
31
+Once you have the project open, you can run it via a desktop window or alternatively on a browser window*.
32
+
33
+\**Nucleus is meant to be run on a desktop window; though it can load and run in a browser*
34
+
35
+### To run via a desktop window...
36
+
37
+(*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)*.)
38
+```bash
39
+yarn tauri dev
40
+```
41
+
42
+### To run via browser...
43
+
44
+```bash
45
+yarn build
46
+yarn start
47
+```
48
+
49
+Navigate to [localhost:8080](http://localhost:8080). You should see the app running in the browser.
50
+
51
+## Compiling Nucleus
52
+
53
+To create an executable file...
54
+```bash
55
+yarn tauri build
56
+```
57
+(*Note: this is for building a single executable for your current OS. To build for other operating systems, read [how to build a Tauri app](https://tauri.app/v1/guides/building/).*)
58
+___
59
+
60
+## Submitting Issues
61
+
62
+If you found a bug, [submit a bug report](https://github.com/mellobacon/Nucleus/issues/new?assignees=&labels=bug&template=bug_report.md&title=%5BBUG%5D). If you want to discuss a feature you would like to see added, [submit a feature request](https://github.com/mellobacon/Nucleus/issues/new?assignees=&labels=enhancement&template=feature_request.md&title=%5BFEATURE%5D).
63
+
64
+***Do not*** submit a pull request that contains major changes unless an issue has been opened for it first. This way it can be discussed.
65
+
66
+Also, when writing your issue, don't delete the issue template. You can fill it out and delete parts that do not apply, but don't delete the whole thing. It's there as a guideline and makes it easier for me to understand your request.
67
+
68
+**Note**: Any issue or pull request that contains spam or trolling will be marked as such and closed. Don't do it.
69
+