aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorArjun Satarkar <me@arjunsatarkar.net>2024-12-31 18:31:12 +0000
committerArjun Satarkar <me@arjunsatarkar.net>2024-12-31 18:31:12 +0000
commit4e4134f8b2c1611e7d40074af55dcef75476016f (patch)
treee3a93c923dccd4985b4d4de8832e054cb4ebdcf0 /README.md
downloadis-the-year-a-perfect-square-4e4134f8b2c1611e7d40074af55dcef75476016f.tar
is-the-year-a-perfect-square-4e4134f8b2c1611e7d40074af55dcef75476016f.tar.gz
is-the-year-a-perfect-square-4e4134f8b2c1611e7d40074af55dcef75476016f.zip
Initial commit
Diffstat (limited to 'README.md')
-rw-r--r--README.md38
1 files changed, 38 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b5b2950
--- /dev/null
+++ b/README.md
@@ -0,0 +1,38 @@
+# sv
+
+Everything you need to build a Svelte project, powered by [`sv`](https://github.com/sveltejs/cli).
+
+## Creating a project
+
+If you're seeing this, you've probably already done this step. Congrats!
+
+```bash
+# 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.