iamDyeus/tkreload

Improve `README.md`

Closed this issue · 9 comments

iamDyeus commented

The current README.md was created in a rush, so it's not quite up to the desired standard.

Here's the type of final README I'm expecting from contributors:

iamDyeus commented

adding this image in the contributing section would be great, isn't it? 😆

image

INEcodes commented

Indeed, quite hilarious.

MonilMehta commented

Can I try this?

  • 👍1
iamDyeus commented

Can I try this?

Go ahead, I'll assign the issue to you if your edits are satisfactory.
If you're not experienced, you might consider co-authoring your PR with someone else. I'll assign the issue to both of you in that case.

iamDyeus commented

@MonilMehta Are you working on it?

MonilMehta commented

Hi, yes I'm working on it, will make a PR by today evening.

MonilMehta commented

I was trying to add a gif to the readme of it working, but wasn't able to make it work after running the sample_app.py, are there any other steps to be followed?

iamDyeus commented

Since auto-reloading isn't functioning at the moment, creating a demo GIF won't be helpful. I suggest we wait until we publish the package to the PyPI directory. Once that's done, we can add a demo GIF to the README.

The sample_app is a basic Tkinter application designed to let users quickly test the module's features, and not related to the module itself.

There are two ways to install and try it out:

  • pip install tkreload (Note: It's not yet available on PyPI, so mark it as "coming soon.")
  • Navigate to the src directory and run pip install . to install locally. Then test the module with tkreload file_name.py

For the demo GIF, you could showcase both major features: auto-reloading on and off, using the sample app.

MonilMehta commented

Alright will try this and get back here

  • 👍1