Skip to content

Commit 5f97b83

Browse files
committed
📝 update README
1 parent 47c24ef commit 5f97b83

1 file changed

Lines changed: 13 additions & 27 deletions

File tree

README.md

Lines changed: 13 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,24 @@
1-
# sv
1+
# hmkconf - Web Configurator for libhmk Keyboards
22

3-
Everything you need to build a Svelte project, powered by [`sv`](https://github.com/sveltejs/cli).
3+
For more information about libhmk, see the [libhmk repository](https://github.com/peppapighs/libhmk).
44

5-
## Creating a project
5+
## Prerequisites
66

7-
If you're seeing this, you've probably already done this step. Congrats!
7+
- [Node.js](https://nodejs.org/en/)
8+
- [bun](https://bun.sh)
89

9-
```sh
10-
# create a new project in the current directory
11-
npx sv create
10+
## Getting Started
1211

13-
# create a new project in my-app
14-
npx sv create my-app
15-
```
16-
17-
## Developing
18-
19-
Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server:
12+
1. Install the dependencies:
2013

21-
```sh
22-
npm run dev
23-
24-
# or start the server and open the app in a new browser tab
25-
npm run dev -- --open
14+
```bash
15+
bun install
2616
```
2717

28-
## Building
29-
30-
To create a production version of your app:
18+
2. Start the development server:
3119

32-
```sh
33-
npm run build
20+
```bash
21+
bun dev
3422
```
3523

36-
You can preview the production build with `npm run preview`.
37-
38-
> To deploy your app, you may need to install an [adapter](https://svelte.dev/docs/kit/adapters) for your target environment.
24+
Open [http://localhost:5173](http://localhost:5173) with your browser to see the result.

0 commit comments

Comments
 (0)