litheory / WindowsCleaner

Scan rubbish files and search big files and delete them(For Windows)

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Advice on README, customization and using setuptools

anqurvanillapy opened this issue · comments

commented
  • Your README.md is undesirable. Try not to use my README as template (because it looks like the one in gmhp). My READMEs are not generalized enough.
    • Requirements in my repo were generated by pipreqs, listing all the dependencies used in the project. Built-in modules are not requirements, such as Tkinter and os, not necessary to list them all.
    • Downloading ZIP of the current source from GitHub is not good. It's better to git-clone the repo, or release your package and let the users download them on the Release page, because your current source is in production, when the users completely don't know whether this package has passed all the tests or is already stable or not.
    • Make the doc prettier. Flaws can be seen in, for instance, this codeblock and the strikethrough. You could re-format them carefully.
  • The customization part, says that users could modify list-typed variable to specify the extensions for custom cleaning. That's awful. New function could be added to read CSV files with custom extensions, so that users can write their own config for cleaning.
  • setup.py script could be taken into your consideration. Your repo looks more like a gist, not a package.
  • Learn about some real-world Python packages with 100+ stars, which are absolutely more helpful for your imitation/copy cating, and going further.

Thank you for your suggestion and I will follow it for improvement.:-)