-
Notifications
You must be signed in to change notification settings - Fork 1
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Updated the README.md file #3
Conversation
This is really great pull request. The only task for you is to review one piece of code where I told you to replace a word with a better one. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great changes! Merging soon.
README.md
Outdated
|
||
```shell | ||
python main.py | ||
``` | ||
|
||
## How to use and configure? | ||
|
||
As of now, no settings screen has been developed, so to use the program as you intend, you need to change the code. Most of the settings and their values are stored in the [`Constants.py`](defs/Constants.py) file. So to make a change, you first need to go to the file in the location `defs\Constants.py` and change the values of the constants as required. Some instructions are provided below. | ||
While a dedicated settings screen is still under development, you can customize the program's behavior by editing the [`Constants.py`](defs/Constants.py) file.Here's how to make changes:<br/> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add a space here between "file." and "Here's"
README.md
Outdated
@@ -10,11 +10,14 @@ | |||
|
|||
## Description | |||
|
|||
This is a Chess AI currently in development. **It is written completely on Python, so it will be slower** than other AIs, but algorithms have been optimized wherever necessary and possible. It uses the [`Pygame`](pygame.org) library to provide the GUI and the media controls. FEN notations are supported upto castling, and future support is in development. | |||
This Chess AI is under development and built entirely with Python for a focus on readability and code clarity. Despite the inherent limitations of the language in performance speed when compared to compiled languages, the core algorithms have been meticulously optimized for maximum speed within Python's capabilities. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Make the text more human. :)
README.md
Outdated
@@ -10,9 +10,9 @@ | |||
|
|||
## Description | |||
|
|||
This Chess AI is under development and built entirely with Python for a focus on readability and code clarity. Despite the inherent limitations of the language in performance speed when compared to compiled languages, the core algorithms have been meticulously optimized for maximum speed within Python's capabilities. | |||
This Chess AI is under development and built entirely with Python for a focus on readability and code clarity. Despite the limitations of the language in performance speed when compared to compiled languages, the core algorithms have been changed for maximum speed within Python's capabilities. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"optimized" word is better than "changed" in this scenario. :)
PR merged. |
No description provided.