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

updated documentation based on comments

Browse Source
This commit is contained in:
LoudSnorer 2023-05-18 07:35:14 -04:00
parent 473f36241a
commit 63998857d5
2 changed files with 71 additions and 50 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -5,16 +5,25 @@ 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.
The deploy.bat file is required to build release and install versions of Oscar using QtCreator or with buildall.bat. The buildall.bat compiles , builds Oscar and calls deploy.bat to create release and install version of Oscar.
There are three sections to this documentation.
1) Required Programs
2) Start Developing using batch files
3) Start Developing using QtCreator
## 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:
- Inno Setup 6.0.3 from <http://www.jrsoftware.org/isdl.php>.
- Inno Setup 6.0.3 from <http://www.jrsoftware.org/isdl.php>. Download and install innosetup-qsp-6.0.3.exe. Download and install innosetup-qsp-6.0.3.exe.
- GIT for windows, from <https://gitforwindows.org/>.
- GIT for windows, from <https://gitforwindows.org/>. GIT for Windows adds itself to your path. GIT for Windows adds itself to your path.
- Gawk is required.
- QT Open Source edition from <https://www.qt.io/download>. I use the latest patch version in the 5.12 LTS series -- version 5.12.8 at the date this was last updated. More recent versions in the 5.12 series should also work. You can use the version included with Git for Windows or install Gawk for Windows from <http://gnuwin32.sourceforge.net/packages/gawk.htm>. The deployment batch file will use the Git for Windows version if gawk.exe is not in your PATH.
- QT Open Source edition from <https://www.qt.io/download>.
I use the latest patch version in the 5.12 LTS series -- version 5.12.8 at the date this was last updated. More recent versions in the 5.12 series should also work.
**Installing Inno Setup 6** **Installing Inno Setup 6**
@ -40,6 +49,10 @@ GIT for Windows adds itself to your path.
Create SSH key and upload to GitLab--See https://docs.gitlab.com/ce/ssh/README.html. Create SSH key and upload to GitLab--See https://docs.gitlab.com/ce/ssh/README.html.
**Installing Gawk (if Git for Windows’ gawk is not used)**
From <http://gnuwin32.sourceforge.net/packages/gawk.htm>, download setup for “Complete package, except sources”. When downloaded, run the setup program. Accept default options and location. The deployment batch file assumes that gawk.exe is in your PATH, so either add c:\\Program Files (x86)\\gnuwin32\\bin to your PATH or copy the executables to some other directory already in your PATH.
**Installing QT** **Installing QT**
Go to QT at <https://www.qt.io/download> and download the Open Source edition of the Windows online installer, qt-unified-windows-x86-3.1.1-online.exe. Run the installer: Go to QT at <https://www.qt.io/download> and download the Open Source edition of the Windows online installer, qt-unified-windows-x86-3.1.1-online.exe. Run the installer:
@ -49,7 +62,7 @@ Go to QT at <https://www.qt.io/download> and download the Open Source edition of
- Click Next to download meta information (this takes a while). - Click Next to download meta information (this takes a while).
- Choose your installation directory (I picked E:\\Qt, but there are no dependencies on where QT is located) - Choose your installation directory (I picked E:\\Qt, but there are no dependencies on where QT is located)
- Select components: - Select components:
- In QT 5.12.*x*: - In QT 5.12.*x*:
@ -58,9 +71,9 @@ Go to QT at <https://www.qt.io/download> and download the Open Source edition of
- MinGW 7.3.0 64-bit - MinGW 7.3.0 64-bit
- Sources - Sources
- QT Debug Information Files - QT Debug Information Files
- In Developer and Designer Tools: - In Developer and Designer Tools:
- QT Creator 4.11.2 CDB Debug - QT Creator 4.11.2 CDB Debug
- Debugging Tools for Windows - Debugging Tools for Windows
- MinGW 7.3.0 32-bit - MinGW 7.3.0 32-bit
@ -70,52 +83,62 @@ And complete the installation (this also takes a while).
## Start Developing using batch files ## Start Developing using batch files
- Requires Qt , Git and Inno setup described in above section.
- Batch files buildall.bat and deploy.bat are used. - Batch files buildall.bat and deploy.bat are used.
- buildall.bat creates a build folder, compiles and executes deploy.bat - buildall.bat creates a build folder, compiles and executes deploy.bat
- Supports both 32 and 64 bit version with an option to build brokenGl - Supports both 32 and 64 bit version with an option to build brokenGl
- Supports Qt 5.9.x 5.12.x 5.15.x
- Auto detection for which compiler to use.
- buildall.bat supports command Line options - buildall.bat supports command Line options
- deploy.bat creates a Release version and an Install version. - deploy.bat creates a release version and an install version.
- deploy.bat is also used by QtCreator - deploy.bat is also used by QtCreator
- The release folder contains OSCAR.exe and all other files necessary to run OSCAR - The release folder contains OSCAR.exe and all other files necessary to run OSCAR
- The install folder contains the installable version of OSCAR...exe - The install folder contains the installable version of OSCAR...exe
- Lists the release and install versions of OSCAR in the build folder. - Lists the release and install versions of OSCAR in the build folder.
### Validate the installed software. #### Validate the installed software.
- Verify Qt - Verify Qt
- \<QtVersion\> will be in the form N.N.N or 5.15.2 - \<QtVersion\> will be in the form N.N.N example 5.15.2
- For example: if Qt is installed at C:\\Qt then - For example: if Qt is installed at D:\\Qt then
- The \<QtFolder\> must contain the following folders: \<QtVersion\> Tools - The \<QtFolder\> must contain the following folders: \<QtVersion\> Tools
- - \<QtFolder\> is C:\\Qt - - \<QtFolder\> is D:\\Qt
- Verify Git and Inno are installed - Verify Git and Inno are installed
- Note: Inno is used to create the Install version of OSCAR. - Note: Inno is used to create the Install version of OSCAR
- Git for windows provides GAWK.
#### Examples use the following assumptions #### Examples use the following assumptions
Except for Inno, Git, Qt, and OSCAR may be located in different locations.
- Inno installed: - Inno installed:
- "C:\\Program Files (x86)\\Inno Setup 6" - "C:\\Program Files (x86)\\Inno Setup 6"
- Git installed: - Git installed:
- "C:\\Program Files\\Git" - "C:\\Program Files\\Git"
- Qtinstalled: - Qtinstalled:
- "C:\\Qt" - "D:\\Qt"
- OSCAR installed: - OSCAR installed:
- "C:\\OSCAR" - "D:\\OSCAR"
### Building Commands #### Building Commands
- Build install version for OSCAR for 32 and 64 bit versions - Build install version for OSCAR for 32 and 64 bit versions
- C:\\OSCAR\OSCAR-code\\Building\\Windows\buildall.bat C:\\Qt - D:\\OSCAR\OSCAR-code\\Building\\Windows\buildall.bat D:\\Qt
- Build install version for OSCAR for 64 bit version - Build install version for OSCAR for 64 bit version
- C:\\OSCAR\OSCAR-code\\Building\\Windows\buildall.bat C:\\Qt 64 - D:\\OSCAR\OSCAR-code\\Building\\Windows\buildall.bat D:\\Qt 64
- Build Just release version for OSCAR for 64 bit version - Build Just release version for OSCAR for 64 bit version
- C:\\OSCAR\OSCAR-code\\Building\\Windows\buildall.bat C:\\Qt 64 skipInstall - D:\\OSCAR\OSCAR-code\\Building\\Windows\buildall.bat D:\\Qt 64 skipInstall
- Build release version for OSCAR for 64 bit version - without deleting build folder first - 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 - D:\\OSCAR\OSCAR-code\\Building\\Windows\buildall.bat D:\\Qt 64 skipInstall remake
- The current folder is not used by the buildall.bat - The current folder is not used by the buildall.bat
- There is a pause when the build completes. - There is a pause when the build completes.
- This insure that the user has a chance to read the build results. - This insure that the user has a chance to read the build results.
- Allows using windows shortcuts to build OSCAR and see results. - Allows using windows shortcuts to build OSCAR and see results.
### Windows Shortcuts Note: The default folder of Qt is C:\\Qt
If the Qt is located at the default folder then the \<QtFolder\> is not required as a command line option.
#### Windows Shortcuts
- Windows shortcuts can be used to execute the build commands or run OSCAR. - Windows shortcuts can be used to execute the build commands or run OSCAR.
- Create shortcut to buildall.bat - Create shortcut to buildall.bat
- rename shortcut to indicate its function - rename shortcut to indicate its function
@ -124,41 +147,39 @@ And complete the installation (this also takes a while).
- For offical OSCAR release should not use remake or skipInsall options - For offical OSCAR release should not use remake or skipInsall options
- Should add skipInstall options for developement, testing, verification - Should add skipInstall options for developement, testing, verification
- Suggestion is to create the following shortcut example. - Suggestion is to create the following shortcut example.
- use options <qtfolder> 64 skipInstall - use options \<qtfolder\> 64 skipInstall
- - name: OSCAR Fresh build - - shortcut name: "OSCAR Fresh build"
- use options <qtfolder> 64 skipInstall remake - use options \<qtfolder\> 64 skipInstall remake
- - name: OSCAR quick rebuild - - shortcut name: "OSCAR quick rebuild"
- Create Shortcut to release version of OSCAR.exe (not the install version) - Create Shortcut to release version of OSCAR.exe (not the install version)
- - name: RUN OSCAR - - shortcut name: "RUN OSCAR"
### Buildall.bat options. #### Buildall.bat options.
- A full list of options can be displayed using the help option. - A full list of options can be displayed using the help option.
**32** Build 32 bit versions **32** Build 32 bit versions
**64** Build 64 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 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 **brokenGL** (special option) to build brokenGL version
**make** The default option. removes and re-creates the build folder. **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 **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 **skipInstall** skips creating the Install version saving both time and disk space
**skipDeploy** skips executing the deploy.bat script. just compiles oscar. **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. 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. This also allows building using windows shortcuts.
1) create a shortcut to buildall.bat 1) create a shortcut to buildall.bat
edit shortcut's property add the necessary options: C:\\Qt 64 remake skipInstall edit shortcut's property add the necessary options: D:\\Qt 64 remake skipInstall
2) create and shortcut for the make option. 2) create and shortcut for the make option.
3) create a shortcut to the **release** version of OSCAR.exe 3) create a shortcut to the **release** version of OSCAR.exe
## Start Developing Oscar in Qt Creator
## 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.

2
Building/Windows/deploy.bat
View File

@ -47,7 +47,7 @@ set toolDir=%parentDir%\OSCAR-code\Building\Windows
set sourceDir=%parentDir%\OSCAR-code\oscar set sourceDir=%parentDir%\OSCAR-code\oscar
echo tooldir is %toolDir% echo tooldir is %toolDir%
::echo p arentDir is %parentDir% ::echo parentDir is %parentDir%
:: echo sourceDir is %sourceDir% :: echo sourceDir is %sourceDir%
echo shadowBuildDir is %shadowBuildDir% echo shadowBuildDir is %shadowBuildDir%
if NOT exist %shadowBuildDir%\OSCAR.exe ( if NOT exist %shadowBuildDir%\OSCAR.exe (