diff --git a/README.md b/README.md new file mode 100644 index 0000000..415ec90 --- /dev/null +++ b/README.md @@ -0,0 +1,66 @@ +# PyDracula - Modern GUI PySide6 / PyQt6 +# + +> ## :gift: **//// DONATE ////** +> ## 🔗 Donate (Gumroad): https://gum.co/mHsRC +> This interface is free for any use, but if you are going to use it commercially, consider helping to maintain this project and others with a donation by Gumroado at the link above. This helps to keep this and other projects active. + +> **Warning**: this project was created using PySide6 and Python 3.9, using previous versions can cause compatibility problems. + +# YouTube - Presentation And Tutorial +Presentation and tutorial video with the main functions of the user interface. +> 🔗 https://youtu.be/9DnaHg4M_AM + +# Multiple Themes +![PyDracula_Default_Dark](https://user-images.githubusercontent.com/60605512/112993874-0b647700-9140-11eb-8670-61322d70dbe3.png) +![PyDracula_Light](https://user-images.githubusercontent.com/60605512/112993918-18816600-9140-11eb-837c-e7a7c3d2b05e.png) + +# Running +> Inside your preferred terminal run the commands below depending on your system, remembering before installing Python 3.9> and PySide6 "pip install PySide6". +> ## **Windows**: +```console +python main.py +``` +> ## **MacOS and Linux**: +```console +python3 main.py +``` +# Compiling +> ## **Windows**: +```console +python setup.py build +``` + +# Project Files And Folders +> **main.py**: application initialization file. + +> **main.ui**: Qt Designer project. + +> **resouces.qrc**: Qt Designer resoucers, add here your resources using Qt Designer. Use version 6 > + +> **setup.py**: cx-Freeze setup to compile your application (configured for Windows). + +> **themes/**: add here your themes (.qss). + +> **modules/**: module for running PyDragula GUI. + +> **modules/app_funtions.py**: add your application's functions here. + +> **modules/app_settings.py**: global variables to configure user interface. + +> **modules/resources_rc.py**: "resource.qrc" file compiled for python using the command: ```pyside6-rcc resources.qrc -o resources_rc.py```. + +> **modules/ui_functions.py**: add here only functions related to the user interface / GUI. + +> **modules/ui_main.py**: file related to the user interface exported by Qt Designer. You can compile it manually using the command: ```pyside6-uic main.ui> ui_main.py ```. +After expoting in .py and change the line "import resources_rc" to "from. Resoucers_rc import *" to use as a module. + +> **images/**: put all your images and icons here before converting to Python (resources_re.py) ```pyside6-rcc resources.qrc -o resources_rc.py```. + +# Projects Created Using PyDracula +**See the projects that were created using PyDracula.** +> To participate create a "Issue" with the name beginning with "#pydracula_project", leaving the link of your project on Github, name of the creator and what is its functionality. Your project will be added and this list will be deleted from "Issue". +**Malicious programs will not be added**! + + +