Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
adbenitez committed Nov 23, 2024
1 parent 72a1338 commit 4ed9437
Showing 1 changed file with 11 additions and 17 deletions.
28 changes: 11 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,52 +1,48 @@
# 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.

<img width=200 src=https://user-images.githubusercontent.com/9800740/170771375-74f8b87d-e47d-4339-bbf3-3bdbfd5a7cd8.png>

[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

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

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.
Expand All @@ -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

0 comments on commit 4ed9437

Please sign in to comment.