README.md edited online with Bitbucket

This commit is contained in:
2023-02-21 00:36:27 +00:00
parent c251770f58
commit 05aa22f629

View File

@@ -1,29 +1,19 @@
# README # # Shogi
A web application for playing the Shogi boardgame with others, developed as a hobby and hosted at [https://lucaserver.space/shogi/](https://lucaserver.space/shogi/)
The application uses sockets to allow players to enjoy sessions in real time.
This README would normally document whatever steps are necessary to get your application up and running.
### What is this repository for? ### ### Known Issues
* The app is intended to support logging in via Microsoft accounts or browser-session (Guest) accounts, but currently Microsoft login does not work.
* The workaround is to use the guest login.
* On first load of the UI, guest account login will fail.
* The workaround is to refresh the page and try again. This issue only happens on first load.
* Quick summary
* Version
* [Learn Markdown](https://bitbucket.org/tutorials/markdowndemo)
### How do I get set up? ### ### Roadmap of features remaining
The app is not yet finished, though much of the functionality exists. Here is a list of what remains.
* Summary of set up * Placing pieces from the hand onto the board.
* Configuration * Checkmate experience in UI
* Dependencies * Preventing the rarely invoked rule where check-mate cannot be gained by placing a pawn from the hand.
* Database configuration * Retaining an archive of games played and move history of each game.
* How to run tests
* Deployment instructions
### Contribution guidelines ###
* Writing tests
* Code review
* Other guidelines
### Who do I talk to? ###
* Repo owner or admin
* Other community or team contact