init: add actual readme
This commit is contained in:
parent
2d05c627f5
commit
5103676234
39
README.md
39
README.md
|
@ -1,38 +1,11 @@
|
|||
# create-svelte
|
||||
# xory's personal website
|
||||
my personal website. made in sveltekit.
|
||||
|
||||
Everything you need to build a Svelte project, powered by [`create-svelte`](https://github.com/sveltejs/kit/tree/main/packages/create-svelte).
|
||||
## roadmap
|
||||
- [x] functioning, good looking, minimal, tty-themed website
|
||||
- [ ] basic .txt blog functionality
|
||||
|
||||
## Creating a project
|
||||
after that its just fog. well see as we go.
|
||||
|
||||
If you're seeing this, you've probably already done this step. Congrats!
|
||||
|
||||
```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 a new issue