4 ms·

Readme needs to state who it is for, where it is best used, what platforms it targets, who the team is working on it and the short medium and longer term goals,

Readme needs to state who it is for, where it is best used, what platforms it targets, who the team is working on it and the short medium and longer term goals, and importantly, why you made it and why a developer should use it. Some open source projects like this can become huge. You never know what might happen.

ktstephano 4y ago
That's a good idea. Later today I'll draft up a new readme with this information. I think it would also be good to reiterate it in the posts I have about the engine so I'll add it there too.
- samstave 4y ago
  May as well provide a link back to this thread in the readme as well for additional context ppl can get from the HN crowd.
ibobev 4y ago
When the project includes some 3D renderer the readme needs also to include some screenshots.
- justinclift 4y ago
  Definitely. Even if they're pretty small, with the user needing to click on them / open in new tab to view them in full glory.
- ktstephano 4y ago
  That's something I'm trying to figure out. I had an earlier version of the readme that had one, but I ran into an old issue where GitHub complains that the repo is over its storage quota. Even after downscaling the image to less than 1mb it still complained so I think I have an issue leftover from an older version of the codebase (I used to store demo assets in the repo).
  - password4321 4y ago
    https://rtyley.github.io/bfg-repo-cleaner/ https://rtyley.github.io/bfg-repo-cleaner/ (Java) seems to be the favored tool; there's also https://github.com/xoofx/git-rocket-filter https://github.com/xoofx/git-rocket-filter (.NET) and the built-in commands: https://stackoverflow.com/questions/2100907/how-to-remove-delete-a-large-file-from-commit-history-in-the-git-repository https://stackoverflow.com/questions/2100907/how-to-remove-de... You'll have to unprotect the branch to force push to GitHub, and anyone who has already cloned the repo may not appreciate basically having to start over, so better to get it over with ASAP!
  - orra 4y ago
    Curious. This script[1] lists the blobs in your repo, which includes deleted files. It seems the deleted resources directory takes up 364MB. That isn't tiny, but it isn't supermassive either. I wonder if GitHub support would be helpful. I don't know if asking them to do a 're-pack' would be beneficial. P.S. thanks for open sourcing this! [1] https://stackoverflow.com/a/42544963 https://stackoverflow.com/a/42544963
    - Cthulhu_ 4y ago
      When I removed an old commited and then removed node_modules folder, I had to do a git filter-branch and a force push; it's doable for your own projects if you don't object to changing the history a bit.

ktstephano 4y ago

That's a good idea. Later today I'll draft up a new readme with this information. I think it would also be good to reiterate it in the posts I have about the engine so I'll add it there too.

samstave 4y ago
May as well provide a link back to this thread in the readme as well for additional context ppl can get from the HN crowd.

ibobev 4y ago

When the project includes some 3D renderer the readme needs also to include some screenshots.

justinclift 4y ago
Definitely. Even if they're pretty small, with the user needing to click on them / open in new tab to view them in full glory.
ktstephano 4y ago
That's something I'm trying to figure out. I had an earlier version of the readme that had one, but I ran into an old issue where GitHub complains that the repo is over its storage quota. Even after downscaling the image to less than 1mb it still complained so I think I have an issue leftover from an older version of the codebase (I used to store demo assets in the repo).
- password4321 4y ago
  https://rtyley.github.io/bfg-repo-cleaner/ https://rtyley.github.io/bfg-repo-cleaner/ (Java) seems to be the favored tool; there's also https://github.com/xoofx/git-rocket-filter https://github.com/xoofx/git-rocket-filter (.NET) and the built-in commands: https://stackoverflow.com/questions/2100907/how-to-remove-delete-a-large-file-from-commit-history-in-the-git-repository https://stackoverflow.com/questions/2100907/how-to-remove-de... You'll have to unprotect the branch to force push to GitHub, and anyone who has already cloned the repo may not appreciate basically having to start over, so better to get it over with ASAP!
- orra 4y ago
  Curious. This script[1] lists the blobs in your repo, which includes deleted files. It seems the deleted resources directory takes up 364MB. That isn't tiny, but it isn't supermassive either. I wonder if GitHub support would be helpful. I don't know if asking them to do a 're-pack' would be beneficial. P.S. thanks for open sourcing this! [1] https://stackoverflow.com/a/42544963 https://stackoverflow.com/a/42544963
  - Cthulhu_ 4y ago
    When I removed an old commited and then removed node_modules folder, I had to do a git filter-branch and a force push; it's doable for your own projects if you don't object to changing the history a bit.