Merge pull request #14 from karayaman/broadcast-readme-update

Readme update for the broadcasting feature.

README.md

@@ -1,9 +1,9 @@
 # Lichess with a real board
-Software that enables you to connect your real life chess board to [Lichess.org](https://lichess.org/) . Using computer vision it will detect the moves you make on your chess board. After that, if it's your turn to move in the online game, it will send your move to Lichess servers using [Lichess Board API](https://lichess.org/blog/XlRW5REAAB8AUJJ-/welcome-lichess-boards) . This project is Lichess-only version of my project [Play online chess with real chess board](https://github.com/karayaman/Play-online-chess-with-real-chess-board) .
+Software that enables you to connect your real life chess board to [Lichess.org](https://lichess.org/) . Using computer vision it will detect the moves you make on your chess board. After that, if it's your turn to move in the online game, it will send your move to Lichess servers using [Lichess Board API](https://lichess.org/blog/XlRW5REAAB8AUJJ-/welcome-lichess-boards) . It can also record your over-the-board games as PGN, so they can be broadcast using  [Lichess Broadcaster](https://lichess.org/broadcast/app) .  This project is Lichess-only version of my project [Play online chess with real chess board](https://github.com/karayaman/Play-online-chess-with-real-chess-board) .
 
 ## GUI
 
-You need to run the GUI to do the steps in Setup and Usage sections and customize how you use the software.
+You need to run the GUI to do the steps in Setup, Usage, Broadcast and Diagnostic sections and customize how you use the software.
 
 ![](https://github.com/karayaman/lichess-with-a-real-board/raw/main/gui.jpg)
 
@@ -15,7 +15,7 @@ You need to run the GUI to do the steps in Setup and Usage sections and customiz
 
 3. Remove all pieces from your chess board.
 
-4. Click "Board Calibration" button.
+4. Click the "Board Calibration" button.
 
 5. Check that corners of your chess board are correctly detected and press key "q" to save detected chess board corners. You don't need to manually select chess board corners; it should be automatically detected by the program. The upper left square, which is covered by points (0,0), (0,1),(1,0) and (1,1) should be a8. You can rotate the image by pressing the key "r" to adjust that. Example chess board detection result:
 
@@ -25,12 +25,36 @@ You need to run the GUI to do the steps in Setup and Usage sections and customiz
 
 1. Place pieces of the chess board to their starting position.
 2. Start the Lichess game.
-3. Click "Start Game" button.
+3. Click the "Start Game" button.
 4. Wait until it says "game started".
 5. Make your move if it's your turn, otherwise make your opponent's move.
-6. Notice that it actually makes your move in the Lichess game, if it's your turn. Otherwise, wait until it says the starting and ending squares of the opponent's move. 
+6. Notice that it actually makes your move in the Lichess game, if it's your turn. Otherwise, wait until it says the starting and ending squares of the opponent's move. To save clock time, you may choose not to wait, but this is not recommended.
 7. Go to step 5.
 
+## Broadcast
+
+1. Switch to the "Broadcast" tab and select the folder where PGN files will be saved. Also, select the same folder in the  [Lichess Broadcaster](https://lichess.org/broadcast/app) .
+
+2. Enter the name of the PGN.
+
+3. Fill in the PGN metadata.
+
+4. Place pieces of the chess board to their starting position.
+
+5. Click the "Start Game" button.
+
+6. The players can now start playing, and the software will update the PGN after each move.
+
+7. After the game ends, stop the software and assign the result of the game.
+
+   <img src="https://github.com/karayaman/lichess-with-a-real-board/blob/main/broadcastgui.jpg?raw=true" style="zoom:67%;" />
+
+## Diagnostic
+
+You need to click the "Diagnostic" button to run the diagnostic process. It will show your chessboard in a perspective-transformed form, exactly as the software sees it. Additionally, it will mark white pieces with a blue circle and black pieces with a green circle, allowing you to verify if the software can detect the pieces on the chess board.
+
+![](https://github.com/karayaman/lichess-with-a-real-board/blob/main/diagnostic.jpg?raw=true)
+
 ## Video
 
 In this section you can find video content related to the software.
@@ -47,6 +71,5 @@ In this section you can find video content related to the software.
 - pyttsx3
 - scikit-image
 - pygrabber
-- mac-say
 - berserk