Update README.md
mellobacon committed
Oct 1, 2022 at 21:43 UTC
235b55182e6ca5db5fd8dabc102e56700a34a8e7
1 file changed
+4
-55
README.md
+4
-55
@@ -8,6 +8,8 @@
8
Download
9
</p>
10
11
+Nucleus is a text editor featuring a clean and easy to use user interface inspired by Visual Studio Code, Atom, Fleet, and others.
12
+
13
### Known issues
14
- TBA
15
@@ -16,58 +18,5 @@
18
## Installation
19
*TBA*
20
19
-## Building for development
20
-This is for those that want to contribute or build on their local machines. If you want to install without building, follow the steps in Installation.
21
-
22
----
23
-This project was made with [Tauri](https://tauri.app/) and was built with...
24
-- [Svelte](https://svelte.dev/) (Frontend)
25
-- [Rust](https://www.rust-lang.org/) (Backend)
26
-- [TypeScript](https://www.typescriptlang.org/)
27
-
28
-...and these build dependencies...
29
-- [Yarn](https://yarnpkg.com/)
30
-- [Node.js](https://nodejs.org)
31
-
32
-Clone the repo via...
33
-```bash
34
-gh repo clone mellobacon/Nucleus
35
-```
36
-or
37
-```bash
38
-git clone https://github.com/mellobacon/Nucleus.git
39
-```
40
-
41
-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).
42
-
43
-Install the dependencies...
44
-
45
-```bash
46
-cd Nucleus
47
-yarn install
48
-```
49
-
50
-### To run via browser...
51
-
52
-```bash
53
-yarn build
54
-yarn start
55
-```
56
-
57
-Navigate to [localhost:8080](http://localhost:8080). You should see the app running in the browser.
58
-
59
-### To run via a desktop window...
60
-
61
-(*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)*.)
62
-```bash
63
-yarn tauri dev
64
-```
65
-
66
-## Building
67
-
68
-To create an executable version of the app:
69
-
70
-```bash
71
-yarn tauri build
72
-```
73
-(*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/).*)
21
+## Contributing
22
+This is for those that want to contribute or build on their local machines. ~~If you want to install without building, follow the steps in Installation.~~ Otherwise, [here's how to contribute](https://github.com/mellobacon/Nucleus/blob/master/CONTRIBUTING.md).