diff --git a/README.md b/README.md index a53effa..911100d 100644 --- a/README.md +++ b/README.md @@ -54,7 +54,13 @@ It's probably better for linux users to install the requirements and run the pyt Getting Started --------------- -###GUI +###Using Prebuilt Binaries + +When using the prebuilt binaries for Windows, Mac, or Ubuntu, there are NO dependencies or extra applications needed. Simply download Web2Exe for the platform of your choice, extract, and double click the app/exe/binary to start. This applies to both the command-line version and the GUI version. + +### Run from Python Source + +####GUI Install dependencies **PIL or Pillow** for icon and icns exporting. @@ -72,7 +78,7 @@ python main.py It's a pretty simple app. Just point it the the directory that your web application lives, customize the options (the two marked with a star are the only ones required) and then choose your export options. The app will export under YOUR_OUTPUT_DIR/YOUR_APP_NAME. -###Command line interface +####Command line interface Dependencies: configobj (install with pip) and Pillow if you want icon replacement (not necessary) @@ -84,6 +90,14 @@ Example usage (if using the prebuilt binary, replace `python command_line.py` wi python command_line.py /var/www/html/CargoBlaster/ --main html/index.html --export-to linux-x64 windows mac --width 900 --height 700 --nw-version 0.10.5 ``` +###GUI Instructions + +To use Web2Exe: + 1. Choose a project folder with at least one html or php file. The name of the export application will be autogenerated from the folder that you choose, so change it if you so desire. + 2. Modify the options as needed. + 3. Choose at least one export platform and then the Export button should enable (as long as the field names marked with a star are filled out and all files in the fields exist). + 4. Click the export button and once it's done, click the "Open Export Folder" button to go to the folder where your exported project will be. + Features --------