Update README.md
This commit is contained in:
parent
70bd4eed48
commit
a27b94d916
1 changed files with 10 additions and 34 deletions
44
README.md
44
README.md
|
@ -1,38 +1,14 @@
|
||||||
# create-svelte
|
# Sprigsy editor
|
||||||
|
|
||||||
Everything you need to build a Svelte project, powered by [`create-svelte`](https://github.com/sveltejs/kit/tree/main/packages/create-svelte).
|
|
||||||
|
|
||||||
## Creating a project
|
# planned for v1
|
||||||
|
- [ ] sprite manager
|
||||||
|
- [ ] level manager
|
||||||
|
- [ ] monaco editor
|
||||||
|
- [ ] **export project for sprig**
|
||||||
|
|
||||||
If you're seeing this, you've probably already done this step. Congrats!
|
|
||||||
|
|
||||||
```bash
|
# planned for v2
|
||||||
# create a new project in the current directory
|
- [ ] typescript support (esbuild prob)
|
||||||
npm create svelte@latest
|
- [ ] build project as a standalone `.html` file (maybe vite?)
|
||||||
|
- [ ] run on device
|
||||||
# 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 a new issue