diff --git a/README.md b/README.md index 0c1b75d..763b584 100644 --- a/README.md +++ b/README.md @@ -1,27 +1,23 @@ -# ChessBoard [![CI](https://github.com/webxdc/ChessBoard/actions/workflows/ci.yml/badge.svg)](https://github.com/webxdc/ChessBoard/actions/workflows/ci.yml) [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier) +# Chess [![CI](https://github.com/DeltaZen/chess/actions/workflows/ci.yml/badge.svg)](https://github.com/DeltaZen/chess/actions/workflows/ci.yml) [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier) A WebXDC chess game for two human players and many observers. -[Download the latest version](https://github.com/webxdc/ChessBoard/releases/latest/download/ChessBoard.xdc), attach to a Delta Chat (or other [WebXDC-capable](https://webxdc.org) client) group or direct chat and play chess! - -## Developing +## Contributing ### Installing Dependencies After cloning this repo, install dependecies: ``` -npm install +pnpm i ``` -### Running tests +### Checking code format ``` -npm run typecheck -npm run format:check -npm test +pnpm check ``` ### Testing the app in the browser @@ -29,9 +25,9 @@ npm test To test your work in your browser (with hot reloading!) while developing: ``` -npm run dev-mini +pnpm start # Alternatively to test in a more advanced WebXDC emulator: -npm run dev +pnpm emulator ``` ### Building @@ -39,14 +35,14 @@ npm run dev To package the WebXDC file: ``` -npm run build +pnpm build ``` To package the WebXDC with developer tools inside to debug in Delta Chat, set the `NODE_ENV` environment variable to "debug": ``` -NODE_ENV=debug npm run build +NODE_ENV=debug pnpm build ``` The resulting optimized `.xdc` file is saved in `dist-xdc/` folder. @@ -60,9 +56,7 @@ git tag -a v1.0.1 git push origin v1.0.1 ``` -## License - -Licensed GPLv3+, see the LICENSE file for details. +## Credits -The chess pieces images are licensed under the `Creative Commons Attribution-Share Alike 3.0 Unported` license and were taken from: +The chess pieces images are from [Cburnett](https://en.wikipedia.org/wiki/User:Cburnett) licensed under the [CC-BY-SA 3.0](https://creativecommons.org/licenses/by-sa/3.0/deed.en) license and can be downloaded from: https://en.wikipedia.org/wiki/User:Cburnett/GFDL_images/Chess