Prepare for release by building 32bit and test drivers

README.md

@@ -36,9 +36,11 @@ This requires a C++ compiler, QT5 development libraries, libusb development pack
 *Other*
 On Windows, you will be required to install the drivers for the device, these can be found in installer/drivers.
 
-Getting Started (from Binary)
------------------------------
-TODO: generate the binary
+Getting Started (from Binary - Windows only)
+--------------------------------------------
+1. Download the installer from here
+2. Run the installer
+3. Plug OSCAR in
 
 Repository Overview
 -------------------
@@ -75,6 +77,12 @@ Contains the OSCAR logo, which is included in the software
 
 Has the control software for your computer. This code presents a GUI for Windows, Linux or OSX based upon Qt5 and libusb. The source code can be found in sw/src, UI designs can be found in src/ui.
 
+Other Notes
+-----------
+*Generating 'Combined' file for programming*
+You will need the Caterina-leonardo.hex file from the bootloaders section of the Arduino code. You will also need the fw.hex generated from this source.
+You will also need the tool srec_cat (part of the SRecord suite of tools).
+`srec_cat fw.hex -intel Caterina-leonardo.hex -intel -o combined.hex -intel`
 
 Licensing
 ---------

installer/oscar.nsi

@@ -6,7 +6,15 @@ Name "OSCAR Screen Adapter"
 OutFile "oscar-installer.exe"
 InstallDir "$LOCALAPPDATA\OSCAR"
 InstallDirRegKey HKCU "Software\OSCAR" ""
-RequestExecutionLevel user
+
+RequestExecutionLevel admin
+
+!define APPNAME "OSCAR Screen Adapter"
+!define COMPANYNAME "Team OSCAR"
+!define VERSIONMAJOR 0
+!define VERSIONMINOR 1
+!define VERSIONBUILD 1
+!define INSTALLSIZE  30000
 
 ;UI settings
 !define MUI_ABORTWARNING
@@ -25,16 +33,38 @@ RequestExecutionLevel user
 Section "OSCAR" SecOSCAR
   SetOutPath "$INSTDIR"
 
-  ;TODO: Add files here
+  ;Actual OSCAR executable
+  File "oscar.exe"
+  File "oscar.ico"
 
-  ;QT Library
+  ;Libraries
   File /r "qtlib\*.*"
   SetOutPath "$INSTDIR\platforms"
   File /r "qtlib\platforms\*.*"
 
+  ;TODO: Install drivers
+
+  ;Add to start menu
+  createDirectory "$SMPROGRAMS\OSCAR"
+  createShortCut  "$SMPROGRAMS\OSCAR\OSCAR.lnk" "$INSTDIR\oscar.exe" "" "$INSTDIR/oscar.ico"
 
+  ;Create unistaller
   WriteRegStr HKCU "Software\OSCAR" "" $INSTDIR
   WriteUninstaller "$INSTDIR\Uninstall.exe"
+
+  ;Registry stuff for Add/remove programs
+  WriteRegStr HKLM "Software\Microsoft\Windows\CurrentVersion\Uninstall\${COMPANYNAME} ${APPNAME}" "DisplayName" "${COMPANYNAME} - ${APPNAME}"
+  WriteRegStr HKLM "Software\Microsoft\Windows\CurrentVersion\Uninstall\${COMPANYNAME} ${APPNAME}" "UninstallString" "$\"$INSTDIR\Uninstall.exe$\""
+  WriteRegStr HKLM "Software\Microsoft\Windows\CurrentVersion\Uninstall\${COMPANYNAME} ${APPNAME}" "QuietUninstallString" "$\"$INSTDIR\Uninstall.exe$\" /S"
+  WriteRegStr HKLM "Software\Microsoft\Windows\CurrentVersion\Uninstall\${COMPANYNAME} ${APPNAME}" "InstallLocation" "$\"$INSTDIR$\""
+  WriteRegStr HKLM "Software\Microsoft\Windows\CurrentVersion\Uninstall\${COMPANYNAME} ${APPNAME}" "Publisher" "${COMPANYNAME}"
+  WriteRegStr HKLM "Software\Microsoft\Windows\CurrentVersion\Uninstall\${COMPANYNAME} ${APPNAME}" "DisplayVersion" "$\"${VERSIONMAJOR}.${VERSIONMINOR}.${VERSIONBUILD}$\""
+  WriteRegDWORD HKLM "Software\Microsoft\Windows\CurrentVersion\Uninstall\${COMPANYNAME} ${APPNAME}" "VersionMajor" ${VERSIONMAJOR}
+  WriteRegDWORD HKLM "Software\Microsoft\Windows\CurrentVersion\Uninstall\${COMPANYNAME} ${APPNAME}" "VersionMinor" ${VERSIONMINOR}
+  ;There is no option for modifying or repairing the install
+  WriteRegDWORD HKLM "Software\Microsoft\Windows\CurrentVersion\Uninstall\${COMPANYNAME} ${APPNAME}" "NoModify" 1
+  WriteRegDWORD HKLM "Software\Microsoft\Windows\CurrentVersion\Uninstall\${COMPANYNAME} ${APPNAME}" "NoRepair" 1
+  WriteRegDWORD HKLM "Software\Microsoft\Windows\CurrentVersion\Uninstall\${COMPANYNAME} ${APPNAME}" "EstimatedSize" ${INSTALLSIZE}
 SectionEnd
 
 ;Descriptions
@@ -45,10 +75,18 @@ LangString DESC_SecOSCAR ${LANG_ENGLISH} "OSCAR control program + drivers"
 
 ;Uninstaller
 Section "Uninstall"
+  ;Delete from Program Files
   Delete "$INSTDIR\platforms\*"
   RMDir "$INSTDIR\platforms"
   Delete "$INSTDIR\*"
 
+  ;Delete from Start Menu
+  Delete "$SMPROGRAMS\OSCAR\OSCAR.link"
+  RMDir "$SMPROGRAMS\OSCAR"
+
+  ;Delete add/remove programs reg keys
+  DeleteRegKey HKLM "Software\Microsoft\Windows\CurrentVersion\Uninstall\${COMPANYNAME} ${APPNAME}"
+
   Delete "$INSTDIR\Uninstall.exe"
   RMDir "$INSTDIR"
   DeleteRegKey /ifempty HKCU "Software\OSCAR"