From 1f709a10be8d897f99326947040572369b3502c0 Mon Sep 17 00:00:00 2001 From: paul Date: Thu, 3 Apr 2025 09:13:30 +0530 Subject: [PATCH] added contributing and updated readme --- CONTRIBUTING | 12 ++++++++++++ README.md | 13 ++++++++----- 2 files changed, 20 insertions(+), 5 deletions(-) create mode 100644 CONTRIBUTING diff --git a/CONTRIBUTING b/CONTRIBUTING new file mode 100644 index 0000000..da8d8c2 --- /dev/null +++ b/CONTRIBUTING @@ -0,0 +1,12 @@ +## Contributing + +Currently if you find bugs or typos, I request you to create an issue first, instead of a Pull request. +That is the best way to contribute to this repo in it's current state. + +I may not get time to review every pull request, unless you are bringing in significant improvement that would have probably taken me weeks to do it myself, I may not be able to take time out of development to review it and don't take closing pull request personally. It's just that I currently don't have time. + +Thank you for understanding. + +## Other ways to contribute. +1. Creating tutorials and helping others on [discord server](https://discord.gg/dHXjrrCA7G) +2. Sharing the tool with others. \ No newline at end of file diff --git a/README.md b/README.md index 8e0e55c..8db4d19 100644 --- a/README.md +++ b/README.md @@ -27,7 +27,7 @@ Build Python GUI's with ease of Drag and drop builders. https://github.com/user-attachments/assets/ac91aa98-843d-4578-b646-88e66bc113de -**Don't like background music? fell free to mute it** +**Don't like background music? feel free to mute it** ## Try PyUIBuilder Try [PyUIBuilder](https://pyuibuilder.com) @@ -51,6 +51,9 @@ Try [PyUIBuilder](https://pyuibuilder.com) - [Author](#author) +## Tutorials +1. Youtube - [PyUibuilder playlist](https://youtube.com/playlist?list=PL0VamwghCfX-KXtGKGLak-C_-Jcx_eOiK&si=vnVr8vdU_JkIEL2f) +2. [Creating sign up form Blog](https://medium.com/python-in-plain-english/create-tkinter-guis-using-tkinter-gui-builder-pyuibuilder-a7422489c55e) ## Docs - Getting started Read the docs on the [Docs page](https://docs.pyuibuilder.com/) @@ -123,7 +126,6 @@ While there are a lot of features, here are few you need to know. ## Roadmap Here are some of the upcoming features. -* Treeview on the sidebar * Support for Event Handlers * Kivy Framework support * Pyqt/PySide Support @@ -131,13 +133,13 @@ Here are some of the upcoming features. To learn more/ see upcoming features visit [roadmap](./roadmap.md) -To stay in loop, subscribe to the free [newsletter](https://paulfreeman.substack.com/subscribe?utm_source=Github-Pybuilder) +To stay in loop, subscribe to the free [newsletter](https://tally.so/r/mVDY7N) ## License - Fund the development -Help fund open-source work and development of this and upcoming projects by purchasing a one-time license. +Help fund development of this and upcoming projects by purchasing a one-time license. -Purchasing License will allow me to focus on development of this tool and provide you access to more advance features, early access and more. +Purchasing License will give you discounted price and provide you access to more advance features, early access and more. The discount's will be available for limited time only on pre-orders. @@ -148,6 +150,7 @@ The discount's will be available for limited time only on pre-orders. | **Lifetime license** (one-time purchase) | 👍️ | ✅ | ✅ | | **Early access** to upcoming features | ❌ | ✅ | ✅ | | **Downloadable Electron App** (upcoming) | ❌ | ✅ | ✅ | +| **Premium widgets**(tabbed widget, scroll widget etc) (upcoming) | ❌ | ✅ | ✅ | | **Run Preview live**(upcoming) | ❌ | ✅ | ✅ | | **Save and Load UI files** (upcoming) | ❌ | ✅ | ✅ | | **Load 3rd party plugins locally** | ❌ | ✅ | ✅ |