User:Daggerstab/Building Stellarium on Windows with Qt Creator - Revision history

Daggerstab: /* Setting environmental variables */

2012-07-16T15:02:41Z

Setting environmental variables

Daggerstab: /* Creating an installer */

2012-04-14T15:25:37Z

Creating an installer

Daggerstab: /* Running Stellarium */

2012-04-14T13:07:53Z

Running Stellarium

Daggerstab: /* Creating an installer */

2012-04-14T12:58:04Z

Creating an installer

Daggerstab at 15:00, 10 November 2011

2011-11-10T15:00:12Z

Daggerstab: /* Opening Stellarium with Qt Creator */

2011-11-10T14:42:57Z

Opening Stellarium with Qt Creator

Daggerstab: first draft

2011-11-09T21:53:42Z

first draft

New page

DRAFT
==Install the Qt SDK==
Stellarium is based on the [http://qt.nokia.com/ Qt] framework, so you need to install it. Before, the Qt libraries and [http://qt.nokia.com/products/developer-tools Qt Creator] were distributed separately, but then Nokia integrated all Qt components in a SDK. So you can download a small installer, and select and download only the components you are going to use.

*Qt downloads page: http://qt.nokia.com/downloads
*The "online installer" for Windows is only 15 MB and allows you to pick which components to download and install
*You need Qt Creator and the Qt Desktop libraries (open source, with MinGW), so in the component selection screen:
**Under "Development Tools":
***Under "Desktop Qt", make sure that the latest version of Qt is checked (as of November 2011, that is 4.7.4). Under the version number, select only "'''Desktop Qt 4.7.4 - MinGW'''"
***Make sure "'''Qt Designer'''" is selected
***You probably don't need anything else under "Development Tools", so feel free to uncheck the rest.
**'''Under "Miscellaneous", make sure that "MinGW 4.4" is checked.''' You don't need the source code. You may need the Qt Examples only if you are a programmer and you want to contribute to Stellarium - they will be useful to understand Qt.
**You need "Documentation" only if you are a programmer who wishes to contribute to Stellarium.
**You don't need "APIs" and "Experimental".

Even if you miss anything at this point, you can install it later with the "Maintain Qt SDK" application (it can be found in the Start menu after the installation is complete).

'''Remember where you install the Qt SDK, because you'll need it later.'''

==Install some GnuWin libraries==
Stellarium needs <code>gettext</code>, <code>libiconv</code> and <code>zlib</code>. You can get them form the GnuWin project:
*http://gnuwin32.sourceforge.net/packages/gettext.htm
*http://gnuwin32.sourceforge.net/packages/libiconv.htm
*http://gnuwin32.sourceforge.net/packages/zlib.htm

For all of them, download the "Complete package, except sources" executable installer. Run the installers and let them install the libraries to the directory they want. It should be something like <code>C:\Program Files\GnuWin32</code>

==Setting environmental variables==
You need to add a few paths to your PATH environmental variable. On Windows, you can modify it with a configuration window: right click on your "My computer" and select "Properties". It's somewhere there. :)

'''TIP:''' The environmental variables window allows you to modify and define env-variables for the current user and for the system. There should be already a "Path" variable defined for the system, but not for the user. Instead of modifying the system PATH, it is more convenient to define a user PATH (just click on the "New..." button and fill in the boxes).

If you have let the Qt SDK install itself in its default location, the path to the Qt libraries should be something like <code>C:\QtSDK\Desktop\Qt\4.7.4\mingw</code> You need to add three subdirectories to the PATH variable:
C:\QtSDK\Desktop\Qt\4.7.4\mingw\bin
C:\QtSDK\Desktop\Qt\4.7.4\mingw\lib
C:\QtSDK\Desktop\Qt\4.7.4\mingw\include

You also need to add the GnuWin libraries:
C:\Program Files\GnuWin32\bin
C:\Program Files\GnuWin32\lib
C:\Program Files\GnuWin32\include

All elements of the list should be separated with a semicolon (;). So the end result should look something like this:
<code>C:\QtSDK\Desktop\Qt\4.7.4\mingw\bin;C:\QtSDK\Desktop\Qt\4.7.4\mingw\lib;C:\QtSDK\Desktop\Qt\4.7.4\mingw\include;C:\Program Files\GnuWin32\bin;C:\Program Files\GnuWin32\lib;C:\Program Files\GnuWin32\include</code>

'''Warning:''' Don't just blindly copy the paths. Make sure that these directories exist and that the Qt version number is the same as yours.

==Install CMake==
CMake download page: http://www.cmake.org/cmake/resources/software.html

And interesting bug: As of 9 November 2011, if you use CMake 2.8.*, on Windows 7, Qt Creator won't show you Stellarium's source file tree in the "Projects" panel. Download and use '''CMake 2.6.4''' (from the same website). If you have any idea why this is happening, contact us in the Stellarium developers mailing list or the Feedback forums.

During the installation, make sure to tell the installer that CMake should be added to the system PATH (for all users). This will save you editing it manually. :)

==Get Stellarium's code==
:''See the [[Bzr checkout|Bazaar checkout instructions]]''

==Opening Stellarium with Qt Creator==
Open Qt Creator.

Open "File" -> "Open File or Project..." (or just press Ctrl+O).

Find the folder where you have put Stellarium's files. Open the topmost <code>CMakeLists.txt</code> file - the one that is '''at the same level''' as the <code>README</code> file and the <code>/src</code> and <code>/data</code> directories.

A "CMake Wizard" window will open. It is small and inconvenient to use. You can resize it to a larger size.
*In the "Build Location" step, there will be a default path already in the location field. '''''Ignore it'''''. Instead:
**Select your base Stellarium location, the same directory where the <code>CMakeLists.txt</code> file was. For example, <code>D:\stellarium\trunk</code>
**Then, add <code>\builds\msys</code>. The whole path should look like something like this:<code>D:\stellarium\trunk\builds\msys</code>
**The point is that this will allow you to run Stellarium directly from inside Qt Creator without having to copy files or to create an installer and install Stellarium.

TO BE CONTINUED

@@ Line 94: / Line 94: @@
 ===Inno Setup and the project file===
-Stellarium uses [http://www.jrsoftware.org/isinfo.php Inno Setup] to create its Windows installers, so you need to download and install Inno Setup first.
+Stellarium uses [http://www.jrsoftware.org/isinfo.php Inno Setup] to create its Windows installers (the self-extracting setup files), so you need to download and install Inno Setup first.
 The Inno Setup project file that contains the rules for creating the installer is called <tt>stellarium.iss</tt>. It is generated from the template <tt>stellarium.iss.cmake</tt> when you run CMake, so:
@@ Line 101: / Line 101: @@
 ===Building in "install" configuration===
 ===Running Inno Setup===
-After Stellarium has been built in the "install configuration" (and files have been copied to the temporary installation directory), open the <tt>stellarium.iss</tt> file with Inno Setup (just double-click it). You can make some final changes before running the script.
+After Stellarium has been built in the "install" configuration (which should have copied the necessary files to the temporary installation directory), open the <tt>stellarium.iss</tt> file with Inno Setup (just double-click it). You can make some final changes before running the script.
 By default, the new installer will be created in the <tt>/installers</tt> sub-directory in the main directory of your Stellarium working tree. Bazaar is set to ignore it, so you can't accidentally commit a setup file to the repository.

← Older revision		Revision as of 13:07, 14 April 2012
Line 79:		Line 79:

	==Running Stellarium==		==Running Stellarium==
		+	You can run the freshly-built Stellarium from inside Qt Creator. You only need to fix the default working directory first.
		+
		+	From the left column, select "Projects" (or press Ctrl+5). Then select the "Run Settings" tab. On that page, under "Run", there must be a "Working directory:" field with a path that looks like this:
		+	C:\stellarium\trunk\builds\msys\src
		+
		+	Select and remove the <tt>builds\msys\src</tt> tail so that the path looks like this:
		+	C:\stellarium\trunk\
		+
		+	After that, you can run the build by clicking on the green arrow button in the left column (or pressing Ctrl+R). You can also run the project in debug mode, etc.
		+
		+	If you have forgotten to set the correct working directory, Stellarium will crash when you try to run it and it will display a "WARNING: could not locate installation directory" error in the log.

	==Creating an installer==		==Creating an installer==

@@ Line 82: / Line 82: @@
 ==Creating an installer==
 ==Using translations==
   TO BE CONTINUED

@@ Line 70: / Line 70: @@
 *In the "Run CMake step", there is an "Arguments" field where you can set CMake command-line arguments.
 **You can use it to set Stellarium's pseudo-installation directory. This is necessary only if you want to use a trick useful to translators (described below) or to create an executable installer. Just type in <code>-DCMAKE_INSTALL_PREFIX=c:\stellarium-temp\</code>, where <code>c:\stellarium-temp\</code> is the path to the pseudo-installation directory. (It is not necessary to exist, CMake will create it.)
   TO BE CONTINUED

@@ Line 27: / Line 27: @@
 ==Setting environmental variables==
-You need to add a few paths to your PATH environmental variable. On Windows, you can modify it with a configuration window: right click on your "My computer" and select "Properties". It's somewhere there. :)
+You need to add a few paths to your PATH environmental variable. On Windows, you can modify it with a configuration window: right click on your "My computer" and select "Properties". It's somewhere there, under "Environmental Variables". :)
-'''TIP:''' The environmental variables window allows you to modify and define env-variables for the current user and for the system. There should be already a "Path" variable defined for the system, but not for the user. Instead of modifying the system PATH, it is more convenient to define a user PATH (just click on the "New..." button and fill in the boxes).
+'''WARNING:''' Don't just blindly copy the paths. Make sure that these directories exist and that the Qt version number is the same as yours.
 If you have let the Qt SDK install itself in its default location, the path to the Qt libraries should be something like <code>C:\QtSDK\Desktop\Qt\4.7.4\mingw</code> You need to add three subdirectories to the PATH variable:
@@ Line 36: / Line 38: @@
   C:\QtSDK\Desktop\Qt\4.7.4\mingw\include
-You also need to add the GnuWin libraries:
+You also need to add the MinGW directories themselves:
   C:\Program Files\GnuWin32\bin
   C:\Program Files\GnuWin32\lib
@@ Line 42: / Line 49: @@
 All elements of the list should be separated with a semicolon (;). So the end result should look something like this:
-<code>C:\QtSDK\Desktop\Qt\4.7.4\mingw\bin;C:\QtSDK\Desktop\Qt\4.7.4\mingw\lib;C:\QtSDK\Desktop\Qt\4.7.4\mingw\include;C:\Program Files\GnuWin32\bin;C:\Program Files\GnuWin32\lib;C:\Program Files\GnuWin32\include</code>
+<code>C:\QtSDK\Desktop\Qt\4.7.4\mingw\bin;C:\QtSDK\Desktop\Qt\4.7.4\mingw\lib;C:\QtSDK\Desktop\Qt\4.7.4\mingw\include;C:\QtSDK\mingw\bin;C:\QtSDK\mingw\lib;C:\QtSDK\mingw\include;C:\Program Files\GnuWin32\bin;C:\Program Files\GnuWin32\lib;C:\Program Files\GnuWin32\include</code>
-−
-'''Warning:''' Don't just blindly copy the paths. Make sure that these directories exist and that the Qt version number is the same as yours.
 ==Install CMake==

@@ Line 68: / Line 68: @@
 **Then, add <code>\builds\msys</code>. The whole path should look like something like this:<code>D:\stellarium\trunk\builds\msys</code>
 **The point is that this will allow you to run Stellarium directly from inside Qt Creator without having to copy files or to create an installer and install Stellarium.
   TO BE CONTINUED