diff --git a/docs/forms/index.rst b/docs/forms/index.rst index 1e8acc9..66b615f 100644 --- a/docs/forms/index.rst +++ b/docs/forms/index.rst @@ -27,7 +27,8 @@ The program begins with the main form: The form is laid out pretty simply, with a list of available component types in the left tree, a set of controls in the middle, and a set of output windows on the right. The Help menu has options to open the online documentation in -a browser, as well as opening the example data folder that is packaged with the tool. +a browser, as well as opening the example data folder that is packaged with the tool. A newer addition to the menu is +also the capability to generate a shortcut icon on the system's desktop to make it very easy to launch the program. To continue to generate parameters, the first step is to select a valid equipment type entry in the left tree, and clicking the *Engage Equipment Type* button. Clicking this with an invalid entry in the tree will emit a dialog. diff --git a/docs/index.rst b/docs/index.rst index acfe841..b5f5218 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -46,9 +46,12 @@ Installation This program should be installed from PyPi using ``pip install energyplus_pet``. Once installed, a new command will be available from that Python environment called ``energyplus_pet_gui``, with a -``.exe`` appended on Windows. A future version of this tool will add an optional process to make it available from -a desktop icon. In the meantime, you are welcome to create a desktop link manually on the operating system of your -choice. +``.exe`` appended on Windows. Run this one time right from the command line where ``pip`` was executed to launch the +program. For easier access, there is an option in the top menu that allows creating a desktop icon. After that is +performed, the user can just launch the program right from the desktop icon. + +To get updates to the program, you simply need to install the latest version using the same ``pip`` version, but let +``pip`` know that it can upgrade existing package installations: ``pip install --upgrade energyplus_pet`` Developing ----------