README
This commit is contained in:
parent
e5c488edcd
commit
a71a72692a
46
README.md
46
README.md
|
@ -1,38 +1,12 @@
|
||||||
# create-svelte
|
# It's just simple
|
||||||
|
You don't need to dedicate all your RAM to run MicroSuck whiteboard
|
||||||
|
Just run on local and do shit
|
||||||
|
|
||||||
Everything you need to build a Svelte project, powered by [`create-svelte`](https://github.com/sveltejs/kit/tree/master/packages/create-svelte).
|
## Brush Sizes, simple clearing, colors included
|
||||||
|
## You can Save ur stuff to png!
|
||||||
|
TODO - the eraser is actually white brush, might look shit when saved :D
|
||||||
|
|
||||||
## Creating a project
|
## Run easily by running run.bat on windows or RunOnLinuxMac.sh, opens in browser right away
|
||||||
|
*On Mac or Linux shell scripts need to be made executable with chmod +x script.sh before they can be run*
|
||||||
If you're seeing this, you've probably already done this step. Congrats!
|
*runs npm i, build and preview*
|
||||||
|
TODO - exexuting build each time on run increases startup time
|
||||||
```bash
|
|
||||||
# create a new project in the current directory
|
|
||||||
npm create svelte@latest
|
|
||||||
|
|
||||||
# create a new project in my-app
|
|
||||||
npm create svelte@latest my-app
|
|
||||||
```
|
|
||||||
|
|
||||||
## Developing
|
|
||||||
|
|
||||||
Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
npm run dev
|
|
||||||
|
|
||||||
# or start the server and open the app in a new browser tab
|
|
||||||
npm run dev -- --open
|
|
||||||
```
|
|
||||||
|
|
||||||
## Building
|
|
||||||
|
|
||||||
To create a production version of your app:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
npm run build
|
|
||||||
```
|
|
||||||
|
|
||||||
You can preview the production build with `npm run preview`.
|
|
||||||
|
|
||||||
> To deploy your app, you may need to install an [adapter](https://kit.svelte.dev/docs/adapters) for your target environment.
|
|
||||||
|
|
Loading…
Reference in New Issue