From 31ed9313bef8758acf800cc9ea499229da7aed8a Mon Sep 17 00:00:00 2001 From: Schmop Date: Sun, 16 Jul 2023 18:59:56 +0200 Subject: [PATCH] Explain better in the r eadme --- README.md | 34 ++++++++++++++++------------------ 1 file changed, 16 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index dff3cf7..c561363 100644 --- a/README.md +++ b/README.md @@ -1,27 +1,25 @@ -# justone +# Just One -This template should help get you started developing with Vue 3 in Vite. +A simple cooperative party game. +Guess the secret words, support the active guesser with associations on small white boards. +But don't talk to each other! -## Recommended IDE Setup +https://www.asmodee.de/produkte/just-one -[VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur) + [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin). +## Local hosting -## Type Support for `.vue` Imports in TS +### Initial install +``` +npm ci +npm run build +``` -TypeScript cannot handle type information for `.vue` imports by default, so we replace the `tsc` CLI with `vue-tsc` for type checking. In editors, we need [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin) to make the TypeScript language service aware of `.vue` types. +### Serving the files +``` +python -m http.server -d dist +``` -If the standalone TypeScript plugin doesn't feel fast enough to you, Volar has also implemented a [Take Over Mode](https://github.com/johnsoncodehk/volar/discussions/471#discussioncomment-1361669) that is more performant. You can enable it by the following steps: - -1. Disable the built-in TypeScript Extension - 1) Run `Extensions: Show Built-in Extensions` from VSCode's command palette - 2) Find `TypeScript and JavaScript Language Features`, right click and select `Disable (Workspace)` -2. Reload the VSCode window by running `Developer: Reload Window` from the command palette. - -## Customize configuration - -See [Vite Configuration Reference](https://vitejs.dev/config/). - -## Project Setup +## Development ```sh npm install