From 7c2dc661e0e0001cb40097d0dadcbd9931d79778 Mon Sep 17 00:00:00 2001 From: Victor Santiago Date: Sat, 2 Dec 2017 18:34:14 -0600 Subject: [PATCH] Update README.md --- README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5c7c76d..467f5a9 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,13 @@ # PyInstallerGUI -This piece of code creates a Windows executable from your code using pyinstaller. + +PyInstallerGUI is a user interface for PyInstaller, a program that freezes (packages) Python programs into stand-alone executables, under Windows, Linux, Mac OS X, FreeBSD, Solaris and AIX. The interface lets you select the options, select the directory and files and with a click of a button it execute the commands in the shell. You can add icons to your executable, version files and also extract the version file from other executable files. + +How to download and use: + +Download the GUI from GITHUB under releases. +Extract the package, then run the command "pip install -r requirements.txt" to install PyInstaller, future and Pillow or install them manually using pip. +When you run the GUI and select a file and don't change any options by default is going to create the program in console and all the files and dependencies in a single directory and the executable will have the PyInstaller icon. If you want to create an executable of a GUI program, for example, a program developed using Tkinter then you have to select --Windowed or the command prompt will show up when you run the program. You can create a single executable file by clicking check on --onefile. A single file has all the files and dependencies packed into itself. If you already have a version file you can select the file and check the option --version-file. If you need to create one you can go on Tools -> GrabVersion and if you are in Windows, for example, you can go to C:\Windows and select notepad.exe to extract the notepad.exe version file. Then you can modify this version file and while you are creating the executable or after by going to Tools -> SetVersion. You can have the executable have any icon you like by selecting a the --icon option. If you are in Windows you must create the icon in the .ico format. + + + +The PyInstaller GUI was only tested in Windows using Python versions 2 and 3.