chris/OSCAR-code
1
0
Fork 0
mirror of https://gitlab.com/pholy/OSCAR-code.git synced 2025-04-05 18:50:44 +00:00
Code Issues Packages Projects Releases Wiki Activity

Windows BUILD-WIN.md add section "Start Developing using batch files"

Browse Source
This commit is contained in:
LoudSnorer 2023-05-16 10:32:12 -04:00
parent a7c1ac9c3b
commit 6d9d7d0c50
1 changed files with 107 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

94
Building/Windows/BUILD-WIN.md
View File

@ -5,7 +5,7 @@ This document is intended to be a brief description of how to install the necess
On my computers, I have QT installed in E:\\QT and the OSCAR code base in E:\\oscar\\oscar-code. On another computer, they are on the F: drive. All references in the deploy.bat file are relative, so it should run with Oscar-code installed at any location. On my computers, I have QT installed in E:\\QT and the OSCAR code base in E:\\oscar\\oscar-code. On another computer, they are on the F: drive. All references in the deploy.bat file are relative, so it should run with Oscar-code installed at any location.
**Required Programs** ## Required Programs
The following programs and files are required to create Windows installers: The following programs and files are required to create Windows installers:
@ -68,7 +68,97 @@ Go to QT at <https://www.qt.io/download> and download the Open Source edition of
And complete the installation (this also takes a while). And complete the installation (this also takes a while).
**Getting Started Developing Oscar in QT Creator** ## Start Developing using batch files
- Batch files buildall.bat and deploy.bat are used.
- buildall.bat creates a build folder, compiles and executes deploy.bat
- Supports both 32 and 64 bit version with an option to build brokenGl
- buildall.bat supports command Line options
- deploy.bat creates a Release version and an Install version.
- deploy.bat is also used by QtCreator
- The release folder contains OSCAR.exe and all other files necessary to run OSCAR
- The install folder contains the installable version of OSCAR...exe
- Lists the release and install versions of OSCAR in the build folder.
### Validate the installed software.
- Verify Qt
- \<QtVersion\> will be in the form N.N.N or 5.15.2
- For example: if Qt is installed at C:\\Qt then
- The \<QtFolder\> must contain the following folders: \<QtVersion\> Tools
- - \<QtFolder\> is C:\\Qt
- Verify Git and Inno are installed
- Note: Inno is used to create the Install version of OSCAR.
#### Examples use the following assumptions
- Inno installed:
- "C:\\Program Files (x86)\\Inno Setup 6"
- Git installed:
- "C:\\Program Files\\Git"
- Qtinstalled:
- "C:\\Qt"
- OSCAR installed:
- "C:\\OSCAR"
### Building Commands
- Build install version for OSCAR for 32 and 64 bit versions
- C:\\OSCAR\OSCAR-code\\Building\\Windows\buildall.bat C:\\Qt
- Build install version for OSCAR for 64 bit version
- C:\\OSCAR\OSCAR-code\\Building\\Windows\buildall.bat C:\\Qt 64
- Build Just release version for OSCAR for 64 bit version
- C:\\OSCAR\OSCAR-code\\Building\\Windows\buildall.bat C:\\Qt 64 skipInstall
- Build release version for OSCAR for 64 bit version - without deleting build folder first
- C:\\OSCAR\OSCAR-code\\Building\\Windows\buildall.bat C:\\Qt 64 skipInstall remake
- The current folder is not used by the buildall.bat
- There is a pause when the build completes.
- This insure that the user has a chance to read the build results.
- Allows using windows shortcuts to build OSCAR and see results.
### Windows Shortcuts
- Windows shortcuts can be used to execute the build commands or run OSCAR.
- Create shortcut to buildall.bat
- rename shortcut to indicate its function
- edit the short cut property and add options to the Target
- Create a shortcut to release version of OSCAR.exe
- For offical OSCAR release should not use remake or skipInsall options
- Should add skipInstall options for developement, testing, verification
- Suggestion is to create the following shortcut example.
- use options <qtfolder> 64 skipInstall
- - name: OSCAR Fresh build
- use options <qtfolder> 64 skipInstall remake
- - name: OSCAR quick rebuild
- Create Shortcut to release version of OSCAR.exe (not the install version)
- - name: RUN OSCAR
### Buildall.bat options.
- A full list of options can be displayed using the help option.
**32** Build 32 bit versions
**64** Build 64 bit versions
32 and 64 bit version are built if both 32 and 64 are used or both not used
**brokenGL** (special option) to build brokenGL version
**make** The default option. removes and re-creates the build folder.
**remake** Execute Make in the existing build folder. Does not re-create the Makefile. Should not be used for Offical OSCAR release
**skipInstall** skips creating the Install version saving both time and disk space
**skipDeploy** skips executing the deploy.bat script. just compiles oscar.
There is a pause when the build completes. This insure that the user has a chance to read the build results.
This also allows building using windows shortcuts.
1) create a shortcut to buildall.bat
edit shortcut's property add the necessary options: C:\\Qt 64 remake skipInstall
2) create and shortcut for the make option.
3) create a shortcut to the **release** version of OSCAR.exe
## Start Developing Oscar in QT Creator
In browser, log into your account at gitlab.com. Select the Oscar project at https://gitlab.com/pholy/OSCAR-code. Clone a copy of the repository to a location on your computer. In browser, log into your account at gitlab.com. Select the Oscar project at https://gitlab.com/pholy/OSCAR-code. Clone a copy of the repository to a location on your computer.