iolivia / rust-sokoban

Rust Sokoban book and code samples
https://sokoban.iolivia.me
MIT License
155 stars 29 forks source link

Unused and too big readme.gif file #106

Open mexchip opened 2 years ago

mexchip commented 2 years ago

File books/en_US/src/images/readme.gif is quite big (55.65 MB) and is not used in the book. The only place where it seems to be referenced is the README.md file but using an incorrect path: <img src="src/images/readme.gif" width="80%">

As the file is in books/en_US, it is duplicated with every translation, increasing disk usage. Github shows a warning message when pushing this file because of its size:

Total 69 (delta 8), reused 54 (delta 7), pack-reused 0
remote: Resolving deltas: 100% (8/8), completed with 1 local object.
remote: warning: See http://git.io/iEPt8g for more information.
remote: warning: File 23acb375f216b5989782ed46e8ce1a50cbd12bea is 55.65 MB; this is larger than GitHub's recommended maximum file size of 50.00 MB
remote: warning: GH001: Large files detected. You may want to try Git Large File Storage - https://git-lfs.github.com.
remote: 

I think of two options:

  1. Reduce readme.gif size and move it to the same level as the README.md file so that it could be easily referenced.
  2. Replace it with another smaller file, I think animations.gif is a good candidate.

I'm working on option 1, you can have a look at https://github.com/mexchip/rust-sokoban/tree/reduce-readme-gif-size, let me know if it´d be an acceptable change for you.