Skip to content

Commit

Permalink
t2tdoc run (followup 8923aa9 & ae397bf)
Browse files Browse the repository at this point in the history
  • Loading branch information
@jef-n
jef-n committed Oct 14, 2018
1 parent 82dccf7 commit faeb160
Show file tree
Hide file tree
Showing 2 changed files with 70 additions and 49 deletions.
59 changes: 35 additions & 24 deletions INSTALL
View file
@@ -1,10 +1,10 @@
QGIS
Building QGIS from source - step by step
Wednesday August 22, 2018
Sunday October 14, 2018


Last Updated: Wednesday August 22, 2018
Last Change : Wednesday August 22, 2018
Last Updated: Sunday October 14, 2018
Last Change : Sunday October 14, 2018


1. Introduction
Expand Down Expand Up @@ -317,16 +317,11 @@ Build and install with ninja:
ninja (uses all cores by default; also supports the above described -jX option)
ninja install

You can build just the targets you need using, for example :
You can build just the targets you need using, for example:

ninja qgis
ninja pycore

You can build just the targets you need using, for example:

- ninja qgis
- ninja pycore


3.8. Building Debian packages
=============================
Expand Down Expand Up @@ -462,7 +457,7 @@ For the QGIS build you need to install following packages from cygwin:

and from OSGeo4W (select Advanced Installation):

- qgis-rel-deps
- qgis-dev-deps

This will also select packages the above packages depend on.

Expand Down Expand Up @@ -1046,37 +1041,53 @@ of space and it's not necessary at all.
4.4. Building on Linux with mxe
===============================

With this approach you can build a windows binary on Linux using mxe MXE (M cross environment).
You can find the build script and a README file in the ms-windows/mxe directory.
With this approach you can cross build a Windows binary on Linux using MXE (M cross environment).
You can find the build script and a README.md file in the ms-windows/mxe directory.

For now, Python buildings cannot be built with mxe.


4.4.1. Initial setup
====================
4.4.1. Building with Docker
===========================

This is the simplest way, but you need to have Docker installed
on your system.

You can use a Docker image to cross build QGIS by calling
the script ms-windows/mxe/build.sh from the root directory of QGIS repository.

=== Building without Docker ====

This requires to install mxe toolchain on your system and build
all dependencies by yourself.


4.4.1.1. Initial setup
======================

Please follow the instructions on mxe website to setup your building toolchain http://mxe.cc/,
take note of the path where you have installed mxe.


4.4.2. Building the dependencies
================================
4.4.1.2. Building the dependencies
==================================

Please see the README under ms-windows/mxe for a list of the dependencies that need to be
built in mxe before attempting to build QGIS.
Please see README.md under ms-windows/mxe for detailed instructions and for the
list of dependencies that need to be built in mxe before attempting to build QGIS.


4.4.3. Cross-Building QGIS
==========================
4.4.1.3. Cross-Building QGIS
============================

Edit the build-mxe.sh script and change the path where your mxe installation is located, you
can also change the build and release directory.
Edit the build-mxe.sh script and optionally adjust the path where your mxe installation is located, you
can also change the build and release directories.


4.4.4. Testing QGIS
4.4.2. Testing QGIS
===================

Copy and unzip the release package on a Windows machine and launch it!
Copy and unzip on the Windows machine package produced by the build and launch the qgis binary: no installation
is required.


5. Building on MacOS X
Expand Down
60 changes: 35 additions & 25 deletions doc/INSTALL.html
View file
Expand Up @@ -77,13 +77,13 @@
<DIV CLASS="header" ID="header">
<H1>QGIS</H1>
<H2>Building QGIS from source - step by step</H2>
<H3>Wednesday August 22, 2018</H3>
<H3>Sunday October 14, 2018</H3>
</DIV>

<DIV CLASS="body" ID="body">
<P>
Last Updated: Wednesday August 22, 2018
Last Change : Wednesday August 22, 2018
Last Updated: Sunday October 14, 2018
Last Change : Sunday October 14, 2018
</P>
<DIV CLASS="toc">

Expand Down Expand Up @@ -532,23 +532,14 @@ <H2>3.7. Starting the compile</H2>
</PRE></div>

<P>
You can build just the targets you need using, for example :
You can build just the targets you need using, for example:
</P>

<div class="code"><PRE>
ninja qgis
ninja pycore
</PRE></div>

<P>
You can build just the targets you need using, for example:
</P>

<UL>
<LI>ninja qgis
<LI>ninja pycore
</UL>

<A NAME="toc11"></A>
<H2>3.8. Building Debian packages</H2>

Expand Down Expand Up @@ -754,7 +745,7 @@ <H3>4.1.2. Other tools and dependencies</H3>
</P>

<UL>
<LI>qgis-rel-deps
<LI>qgis-dev-deps
</UL>

<P>
Expand Down Expand Up @@ -1486,38 +1477,57 @@ <H3>4.3.3. Cleanup</H3>
<H2>4.4. Building on Linux with mxe</H2>

<P>
With this approach you can build a windows binary on Linux using mxe MXE (M cross environment).
You can find the build script and a README file in the ms-windows/mxe directory.
With this approach you can cross build a Windows binary on Linux using MXE (M cross environment).
You can find the build script and a README.md file in the ms-windows/mxe directory.
</P>
<P>
For now, Python buildings cannot be built with mxe.
</P>

<H3>4.4.1. Initial setup</H3>
<H3>4.4.1. Building with Docker</H3>

<P>
This is the simplest way, but you need to have Docker installed
on your system.
</P>
<P>
You can use a Docker image to cross build QGIS by calling
the script ms-windows/mxe/build.sh from the root directory of QGIS repository.
</P>
<P>
=== Building without Docker ====
</P>
<P>
This requires to install mxe toolchain on your system and build
all dependencies by yourself.
</P>

<H4>4.4.1.1. Initial setup</H4>

<P>
Please follow the instructions on mxe website to setup your building toolchain <A HREF="http://mxe.cc/">http://mxe.cc/</A>,
take note of the path where you have installed mxe.
</P>

<H3>4.4.2. Building the dependencies</H3>
<H4>4.4.1.2. Building the dependencies</H4>

<P>
Please see the README under ms-windows/mxe for a list of the dependencies that need to be
built in mxe before attempting to build QGIS.
Please see README.md under ms-windows/mxe for detailed instructions and for the
list of dependencies that need to be built in mxe before attempting to build QGIS.
</P>

<H3>4.4.3. Cross-Building QGIS</H3>
<H4>4.4.1.3. Cross-Building QGIS</H4>

<P>
Edit the build-mxe.sh script and change the path where your mxe installation is located, you
can also change the build and release directory.
Edit the build-mxe.sh script and optionally adjust the path where your mxe installation is located, you
can also change the build and release directories.
</P>

<H3>4.4.4. Testing QGIS</H3>
<H3>4.4.2. Testing QGIS</H3>

<P>
Copy and unzip the release package on a Windows machine and launch it!
Copy and unzip on the Windows machine package produced by the build and launch the qgis binary: no installation
is required.
</P>

<A NAME="toc18"></A>
Expand Down

0 comments on commit faeb160

Please sign in to comment.