Updated README.md
mellbacon committed
Jul 14, 2022 at 19:00 UTC
e98e9a1ebd2965ba8edf7c3a9f49875bcc7115bd
1 file changed
+46
-78
README.md
+46
-78
@@ -1,107 +1,75 @@
1
-# This repo is no longer maintained. Consider using `npm init vite` and selecting the `svelte` option or — if you want a full-fledged app framework and don't mind using pre-1.0 software — use [SvelteKit](https://kit.svelte.dev), the official application framework for Svelte.
2
-
1
+<h1 align="center" style="position: relative;">
2
+ <img width="200" src="./public/assets/images/Icon(1).png" alt="The scp terminal icon" /><br>
3
+ Nucleus
4
+</h1>
5
+<h3 align="center">A text editor with better UI than your mom :var:</h3>
6
+<p align="center">
7
+ License •
8
+ Download
9
+</p>
10
+
11
+### Known issues
12
+- TBA
13
+
14
+**This project is a WIP. Bugs and missing or incomplete features will be present**
15
+
16
+## Installation
17
---
18
+*TBA*
19
5
-# svelte app
6
-
7
-This is a project template for [Svelte](https://svelte.dev) apps. It lives at https://github.com/sveltejs/template.
8
-
9
-To create a new project based on this template using [degit](https://github.com/Rich-Harris/degit):
10
-
11
-```bash
12
-npx degit sveltejs/template svelte-app
13
-cd svelte-app
14
-```
15
-
16
-*Note that you will need to have [Node.js](https://nodejs.org) installed.*
17
-
20
+## Building for development
21
+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.
22
19
-## Get started
20
-
21
-Install the dependencies...
23
+---
24
+This project was made with [Tauri](https://tauri.app/) and was built with...
25
+- [Svelte](https://svelte.dev/) (Frontend)
26
+- [Rust](https://www.rust-lang.org/) (Backend)
27
+- [TypeScript](https://www.typescriptlang.org/)
28
23
-```bash
24
-cd svelte-app
25
-npm install
26
-```
29
+...and these build dependencies...
30
+- [Yarn](https://yarnpkg.com/)
31
+- [Node.js](https://nodejs.org)
32
28
-...then start [Rollup](https://rollupjs.org):
33
+(*Note: Make sure you have these [prerequisites](https://tauri.app/v1/guides/getting-started/prerequisites) before continuing*.)
34
35
+Clone the repo via...
36
```bash
31
-npm run dev
37
+gh repo clone mellobacon/Nucleus
38
```
33
-
34
-Navigate to [localhost:8080](http://localhost:8080). You should see your app running. Edit a component file in `src`, save it, and reload the page to see your changes.
35
-
36
-By default, the server will only respond to requests from localhost. To allow connections from other computers, edit the `sirv` commands in package.json to include the option `--host 0.0.0.0`.
37
-
38
-If you're using [Visual Studio Code](https://code.visualstudio.com/) we recommend installing the official extension [Svelte for VS Code](https://marketplace.visualstudio.com/items?itemName=svelte.svelte-vscode). If you are using other editors you may need to install a plugin in order to get syntax highlighting and intellisense.
39
-
40
-## Building and running in production mode
41
-
42
-To create an optimised version of the app:
43
-
39
+or
40
```bash
45
-npm run build
41
+git clone https://github.com/mellobacon/Nucleus.git
42
```
43
48
-You can run the newly built app with `npm run start`. This uses [sirv](https://github.com/lukeed/sirv), which is included in your package.json's `dependencies` so that the app will work when you deploy to platforms like [Heroku](https://heroku.com).
44
+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).
45
50
-
51
-## Single-page app mode
52
-
53
-By default, sirv will only respond to requests that match files in `public`. This is to maximise compatibility with static fileservers, allowing you to deploy your app anywhere.
54
-
55
-If you're building a single-page app (SPA) with multiple routes, sirv needs to be able to respond to requests for *any* path. You can make it so by editing the `"start"` command in package.json:
56
-
57
-```js
58
-"start": "sirv public --single"
59
-```
60
-
61
-## Using TypeScript
62
-
63
-This template comes with a script to set up a TypeScript development environment, you can run it immediately after cloning the template with:
46
+Install the dependencies...
47
48
```bash
66
-node scripts/setupTypeScript.js
49
+cd Nucleus
50
+yarn install
51
```
52
69
-Or remove the script via:
53
+### To run via browser...
54
55
```bash
72
-rm scripts/setupTypeScript.js
56
+yarn start
57
```
58
75
-If you want to use `baseUrl` or `path` aliases within your `tsconfig`, you need to set up `@rollup/plugin-alias` to tell Rollup to resolve the aliases. For more info, see [this StackOverflow question](https://stackoverflow.com/questions/63427935/setup-tsconfig-path-in-svelte).
76
-
77
-## Deploying to the web
78
-
79
-### With [Vercel](https://vercel.com)
59
+Navigate to [localhost:8080](http://localhost:8080). You should see the app running in the browser.
60
81
-Install `vercel` if you haven't already:
61
+### To run via a desktop window...
62
63
```bash
84
-npm install -g vercel
64
+yarn tauri dev
65
```
66
87
-Then, from within your project folder:
88
-
89
-```bash
90
-cd public
91
-vercel deploy --name my-project
92
-```
93
-
94
-### With [surge](https://surge.sh/)
95
-
96
-Install `surge` if you haven't already:
97
-
98
-```bash
99
-npm install -g surge
100
-```
67
+## Building
68
+---
69
102
-Then, from within your project folder:
70
+To create an executable version of the app:
71
72
```bash
105
-npm run build
106
-surge public my-project.surge.sh
73
+yarn tauri build
74
```
75
+(*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/).*)
\ No newline at end of file