diff --git a/README.md b/README.md index 5c91169b0ca6508bb24301c957a9edea5abf2b01..5d028563220b9a0d40a1087a55ce56f11fcc7756 100644 --- a/README.md +++ b/README.md @@ -1,38 +1,39 @@ -# create-svelte +# MP3 Experiment Player -Everything you need to build a Svelte project, powered by [`create-svelte`](https://github.com/sveltejs/kit/tree/master/packages/create-svelte). +WebApp to play an mp3 file in sync at a specific time -## 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 -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: +You'll need at least Node 16 installed on your computer. ```bash -npm run dev +# Install pnpm if you don't have it already: +corepack enable +corepack prepare pnpm@latest --activate + +# Clone this repo: +git clone git@gitlab.fachschaften.org:jfowl/mp3-experiment-player.git +cd mp3-experiment-player -# or start the server and open the app in a new browser tab -npm run dev -- --open +# Install dependencies: +pnpm install + +# Run dev server +pnpm run dev ``` ## Building -To create a production version of your app: +To create a production version: ```bash -npm run build +pnpm build ``` -You can preview the production build with `npm run preview`. +The output lives in the `public/` directory. + +## License -> To deploy your app, you may need to install an [adapter](https://kit.svelte.dev/docs/adapters) for your target environment. +This project is licensed under the MIT License. diff --git a/screenshot.png b/screenshot.png new file mode 100644 index 0000000000000000000000000000000000000000..2aae060742f6b24f0b4f5ef9c0b92818b0da9e8d Binary files /dev/null and b/screenshot.png differ