search

shaack / cm-chessboard

A JavaScript chessboard without dependencies. Rendered in SVG, coded in ES6. Views FEN, handles move input, animated, responsive, expandable
MIT License
209 stars 63 forks source link

Would it be possible to update the readme file? #130

Closed levallem closed 9 months ago

levallem commented 10 months ago

Would it be possible to update the readme file? especially this part After installation, copy the sprite in cm-chessboard/assets/images/ to your projects assets/images/ folder. If you put the sprite somewhere else you have to configure the location with {sprite.url: "./url/of/chessboard-sprite.svg"} (see section 'Configuration' below).

shaack commented 9 months ago

Thank you for your feedback. What was it exactly that you wanted to achieve and what got you stuck?

levallem commented 9 months ago

Hi shaack

I would like to start using cm-chessboard but I have not understood the instructions in the readme file. I believe the instructions are from an older version of cm-chessboard. After installation you indicate: After installation, copy the sprite in cm-chessboard/assets/images/ to your projects assets/images/ Images does not exist in your project. neither chessboard-sprite.svg Maybe for someone who comes from previous versions they will be familiar. But in my case I just discovered cm-chessboard and with these instructions I have not been able to get it up and running. That's why I ask if you can update the readme file please.

shaack commented 9 months ago

Ah, I get it. That was kind of out of my focus, sorry.

I have now done a huge update of the README and added a "first steps" section: https://github.com/shaack/cm-chessboard#installation-and-first-steps

I would love to get some feedback if this works well and is understandable.

levallem commented 9 months ago

Thanks shaack, now it is much clearer and easier to install. I'm testing with cm-chessboard in my project.