Update README
This commit is contained in:
parent
31e2a60791
commit
6fa579e604
2 changed files with 6 additions and 34 deletions
40
README.md
40
README.md
|
@ -1,38 +1,10 @@
|
||||||
# sv
|
# Embroidery Viewer
|
||||||
|
|
||||||
Everything you need to build a Svelte project, powered by [`sv`](https://github.com/sveltejs/cli).
|
A free online tool to view embroidery files.
|
||||||
|
Available at https://embroideryviewer.xyz.
|
||||||
|
|
||||||
## Creating a project
|

|
||||||
|
|
||||||
If you're seeing this, you've probably already done this step. Congrats!
|
Current supported formats: **.pes, .dst, .pec, .jef and .exp**.
|
||||||
|
|
||||||
```bash
|
Inspired by https://github.com/redteam316/html5-embroidery.git..
|
||||||
# create a new project in the current directory
|
|
||||||
npx sv create
|
|
||||||
|
|
||||||
# create a new project in my-app
|
|
||||||
npx sv create 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://svelte.dev/docs/kit/adapters) for your target environment.
|
|
||||||
|
|
BIN
demo.gif
Normal file
BIN
demo.gif
Normal file
Binary file not shown.
After Width: | Height: | Size: 4.9 MiB |
Loading…
Add table
Reference in a new issue