From e744f3f62cc960b9daa603c4d4360b18817ddc42 Mon Sep 17 00:00:00 2001 From: Matthieu Bessat Date: Sun, 5 Mar 2023 11:20:52 +0100 Subject: [PATCH] feat: proper README.md --- README.md | 36 ++++++++---------------------------- 1 file changed, 8 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index 5c91169..497b467 100644 --- a/README.md +++ b/README.md @@ -1,38 +1,18 @@ -# create-svelte +# Application web de controle du robot coupe junior 2023 -Everything you need to build a Svelte project, powered by [`create-svelte`](https://github.com/sveltejs/kit/tree/master/packages/create-svelte). +Cette application est principalement codé avec svelte, svelte-kit. -## Creating a project +## Développer -If you're seeing this, you've probably already done this step. Congrats! +- Cloner ce repository : `git clone https://forge.lefuturiste.fr/werobot/tr2023-client` +- Installez les dépendances avec la commande : `npm install` +- Démarrez le serveur de dév avec la commande : `npm run dev` -```bash -# create a new project in the current directory -npm create svelte@latest +## Builder -# 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: +Pour build une version de production. ```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.