aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorjwansek <eddie.atten.ea29@gmail.com>2018-04-12 17:45:04 +0100
committerjwansek <eddie.atten.ea29@gmail.com>2018-04-12 17:45:04 +0100
commitcb95e987d26fc2d0b1f741d0be86a5d4a873daeb (patch)
tree28671313df034e34a55ac4a67df2dcf03c83ed24 /README.md
parentdf12a1d0712ac6a75b06f580cc2b07de4cae83dc (diff)
downloadeehph2-cb95e987d26fc2d0b1f741d0be86a5d4a873daeb.tar.gz
eehph2-cb95e987d26fc2d0b1f741d0be86a5d4a873daeb.zip
improved readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md22
1 files changed, 15 insertions, 7 deletions
diff --git a/README.md b/README.md
index 12b3f7e..8d343f1 100644
--- a/README.md
+++ b/README.md
@@ -1,11 +1,19 @@
# eehph2
EEHPH Photo Viewer v2
-A lite photo viewer optimised for Windows 10
+A light photo viewer designed for Windows 10.
-Several .dlls are required for this program to work. Therefore I set the cwd to the one in which the
-file is located. However the program doesn't know where the install location is. Therefore there is
-on_install_setup.exe to put the install location in APPDATA/LOCAL/EEHPH2/location.txt. This is a simple
-python script compiled using Pyinstaller. (source on_install_setup/on_install_setup.py) Then when the program
-is run, another script (TODO) is run which changes the cwd to the one in location.txt and runs the main
-program as a module. After the user closes it it switches back to the original cwd.
+The program can be run anywhere by right clicking and opening with this
+file. This is a problem because with program requires several .ddls to work.
+The solution is to set the program to a run a small script which changes the
+cwd to the one in which the app is located (EEHPH2.py) and then run the main
+app (EEHPH2_app.py) as a module. However the program doens't know where the
+installation directory is. The solution is to use a script (on_install_setup.exe)
+which sets the location of the installation directory in
+%ALLUSERSPROFILE%/EEHPH2/location.txt. This script was compiled using pyinstaller
+and it's source is on_install_setup/on_install_setup.py. There is a another script,
+cleanup.exe, which was made in a similar way which deletes this file on uninstall.
+
+This program in written in Python3, compiled using cx_Freeze, and packaged using
+inno. The inno script is at setup.iss. The setup for the cx_Freeze is setup.py.
+This was done for the functionality of intallation and uninstallation scripts. \ No newline at end of file