Skip to content

Commit

Permalink
doc: Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
itsamirhn committed Jun 6, 2024
1 parent c9c528e commit cba91c9
Show file tree
Hide file tree
Showing 2 changed files with 45 additions and 1 deletion.
46 changes: 45 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,47 @@

# Chess

Fully Object-Oriented Chess in Java
A Fully Object-Oriented Chess, written in pure Java


## Features

- Support Custom [FEN](https://en.wikipedia.org/wiki/Forsyth–Edwards_Notation)
- Multiplayer
- Undo Move
- Plays sound
- Support Stalement and Checkmate edge Cases
- Support [En Passant](https://en.wikipedia.org/wiki/En_passant) Move


## Demo

![Demo](demo.gif)


## Documentation
You can visit the online Documentation on here: [Documentation](https://itsamirhn.github.io/Chess)


## Run Locally

1. Install JRE 21 or higher
2. Download the latest `Chess-1.0-SNAPSHOT.jar` file from [releases page](https://github.com/itsamirhn/Chess/releases)
3. Run the following command:
```bash
java -jar Chess-1.0-SNAPSHOT.jar
```

## Running Tests

The project use [Maven](https://maven.apache.org/) as build automation tool. To run tests, run the following command:

```bash
mvn test
```


## Authors

- [@itsamirhn](https://github.com/itsamirhn)

Binary file added demo.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit cba91c9

Please sign in to comment.