mirror of
https://gitlab.com/pholy/OSCAR-code.git
synced 2025-04-05 02:30:44 +00:00
updated documentation based on comments
This commit is contained in:
LoudSnorer
parent
473f36241a
commit
63998857d5
@ -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.
|
||||
|
||||
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
|
||||
|
||||
The following programs and files are required to create Windows installers:
|
||||
|
||||
- Inno Setup 6.0.3 from <http://www.jrsoftware.org/isdl.php>. Download and install innosetup-qsp-6.0.3.exe.
|
||||
|
||||
- GIT for windows, from <https://gitforwindows.org/>. GIT for Windows adds itself to 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.
|
||||
|
||||
- Inno Setup 6.0.3 from <http://www.jrsoftware.org/isdl.php>.
|
||||
Download and install innosetup-qsp-6.0.3.exe.
|
||||
- GIT for windows, from <https://gitforwindows.org/>.
|
||||
GIT for Windows adds itself to your path.
|
||||
- Gawk is required.
|
||||
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**
|
||||
|
||||
@ -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.
|
||||
|
||||
**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**
|
||||
|
||||
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:
|
||||
@ -70,52 +83,62 @@ And complete the installation (this also takes a while).
|
||||
|
||||
## Start Developing using batch files
|
||||
|
||||
- Requires Qt , Git and Inno setup described in above section.
|
||||
- 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
|
||||
- Supports Qt 5.9.x 5.12.x 5.15.x
|
||||
- Auto detection for which compiler to use.
|
||||
- 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
|
||||
- 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.
|
||||
#### 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
|
||||
- \<QtVersion\> will be in the form N.N.N example 5.15.2
|
||||
- For example: if Qt is installed at D:\\Qt then
|
||||
- The \<QtFolder\> must contain the following folders: \<QtVersion\> Tools
|
||||
- - \<QtFolder\> is C:\\Qt
|
||||
- - \<QtFolder\> is D:\\Qt
|
||||
- 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
|
||||
|
||||
Except for Inno, Git, Qt, and OSCAR may be located in different locations.
|
||||
|
||||
- Inno installed:
|
||||
- "C:\\Program Files (x86)\\Inno Setup 6"
|
||||
- Git installed:
|
||||
- "C:\\Program Files\\Git"
|
||||
- Qtinstalled:
|
||||
- "C:\\Qt"
|
||||
- "D:\\Qt"
|
||||
- OSCAR installed:
|
||||
- "C:\\OSCAR"
|
||||
- "D:\\OSCAR"
|
||||
|
||||
### Building Commands
|
||||
#### Building Commands
|
||||
|
||||
- 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
|
||||
- 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
|
||||
- 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
|
||||
- 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
|
||||
- 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
|
||||
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.
|
||||
- Create shortcut to buildall.bat
|
||||
- rename shortcut to indicate its function
|
||||
@ -124,15 +147,15 @@ And complete the installation (this also takes a while).
|
||||
- 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
|
||||
- use options \<qtfolder\> 64 skipInstall
|
||||
- - shortcut name: "OSCAR Fresh build"
|
||||
- use options \<qtfolder\> 64 skipInstall remake
|
||||
- - shortcut name: "OSCAR quick rebuild"
|
||||
- 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.
|
||||
**32** Build 32 bit versions
|
||||
|
||||
@ -152,13 +175,11 @@ And complete the installation (this also takes a while).
|
||||
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
|
||||
edit shortcut's property add the necessary options: D:\\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
|
||||
## 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.
|
||||
|
||||
|
||||
@ -47,7 +47,7 @@ set toolDir=%parentDir%\OSCAR-code\Building\Windows
|
||||
set sourceDir=%parentDir%\OSCAR-code\oscar
|
||||
|
||||
echo tooldir is %toolDir%
|
||||
::echo p arentDir is %parentDir%
|
||||
::echo parentDir is %parentDir%
|
||||
:: echo sourceDir is %sourceDir%
|
||||
echo shadowBuildDir is %shadowBuildDir%
|
||||
if NOT exist %shadowBuildDir%\OSCAR.exe (
|
||||
|
||||
Loading…
Reference in New Issue
Block a user