Repository navigation
Update Readme #21
Description
Thanks for the taking this package forward.
It is looking very cool.
I wanted to convert from notnil to this one but it seem that you have been mainly busy with the funcionality of the code and did not have the time to update it. At this time the readme and even the docs at https://pkg.go.dev/github.com/corentings/chess/v2 can be very deceiving.
So i took a look at the source code and decided to generate some api docs and some examples to help the transition.
The code and md files are at https://github.com/audiBookning/corentings-chess-API-examples. They are mainly some notes for my personal use and have no intention of being transformed in a PR but i remembered that they can be useful in some way to this repo or to someone else that is in a similar situation as myself. Since they were generated i only tested that the examples seem to work as intended and that the api md file seem to be correct. But it still needs confirmation.
Feel free to use and abuse if need be.
At least until the docs can be updated.
Hope it helps someone.
Activity
CorentinGS commentedon Feb 3, 2025
Hello,
You are right, I've been focusing mostly on adding new features like variations, Zobrist hash, polyglot book and on rewriting some of the code to reduce allocations, have a complete & fast PGN parser etc.
Now I probably should try to improve the documentation! Thank you very much for your issue and the work you have started on your own.
Would you mind opening a PR with some of the examples you find useful so we can start adding some code examples directly in the repo?
I'll use your API.md file to start improving the README and complete the wiki. I'll also focus on updating the documentation in the code directly.
If you like this package and what I'm trying to achieve, feel free to open more issues and suggest some improvements so it can match your needs.
audiBookning commentedon Feb 3, 2025
Thanks for the quick response.
As for the examples. They were basically created for me to be sure that the API was working correctly. So i do no think that they are really useful beyond that. They are too basic and are repeating most of what is already in the API file.
But if you which i can make a PR with them.
On the other hand when i find the time i could try to expand on some of them and have more complete example to PR.
I do like the package. It is very simple but also very efficient and complete.
My project is just a hobby at this time among other time preoccupations. But i have focused on it from time to time. And this package and its parent is certainly a great help.
The variations methods are one of the things that i had felt a shame that it was not in the package. So it is a very welcome feature from my point of view.
The lexer is also great. It was predicted that i would need one so I started some time ago to use antlr (a little heavyweight but my experience with lexer/parser is very weak).
And though i made good progress, i think that there were still some little bugs. I never finished it since i haven't have a strong need for it yet. It was mainly for the parsing of pgn with variations. But fortunately it seem that most of the work has already been done by you already. Thanks.