From 22bf650f04f6f33489b6c85772da5011cf6a981e Mon Sep 17 00:00:00 2001 From: Daan Vanden Bosch Date: Sat, 14 Sep 2019 18:04:28 +0200 Subject: [PATCH] Removed all reference to React and Mobx from the readme and added a note about linting/formatting. --- README.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 7becc584..c6a8e8ea 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ Phantasmal World is a suite of tools for Phantasy Star Online. ## For Developers -React is used for the frontend, MobX is used for state management and THREE.js for 3D graphics. See [features](./FEATURES.md) for a list of features, planned features and bugs. +See [features](./FEATURES.md) for a list of features, planned features and bugs. ### Getting Started @@ -12,11 +12,17 @@ React is used for the frontend, MobX is used for state management and THREE.js f 2. cd to the project directory 3. Install dependencies with `yarn` 4. Launch server on [http://localhost:1623/](http://localhost:1623/) with `yarn start` -5. src/index.tsx is the application's entry point +5. src/index.ts is the application's entry point ### Tests -Run tests with `yarn test`. The testing framework used is Jest. +Run tests with `yarn test` (or `yarn test --watch`). The testing framework used is Jest. + +### Linting and Code Formatting + +ESLint and Prettier are used for linting and formatting. + +Run with `yarn lint` and/or configure your editor to use the ESLint/Prettier configuration. ### Production Build