[doc] host: Reformat build instructions for all platforms

This commit is contained in:
Jonathan Rubenstein 2021-05-13 20:38:04 -04:00 committed by Geoffrey McRae
parent d5fb1bab9a
commit 75d48de905

View File

@ -9,15 +9,20 @@ Building
For Windows on Windows For Windows on Windows
~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~
1. download and install msys2 x86_64 from 1. Download and install msys2 x86_64 from
`http://www.msys2.org/ <http://www.msys2.org/>`__ following the setup `http://www.msys2.org/ <http://www.msys2.org/>`__ following the setup
instructions provided instructions provided
2. execute ``pacman -Fy`` and then 2. Run the MSYS2 shell.
``pacman -Sy git make mingw-w64-x86_64-gcc mingw-w64-x86_64-cmake`` 3. Download build dependencies with pacman
3. run "C:\msys64\mingw64.exe"
4. checkout the project .. code:: bash
pacman -Fy
pacman -Sy git make mingw-w64-x86_64-gcc mingw-w64-x86_64-cmake
4. Checkout the project
``git clone https://github.com/gnif/LookingGlass.git`` ``git clone https://github.com/gnif/LookingGlass.git``
5. configure the project and build it 5. Configure the project and build it
.. code:: bash .. code:: bash
@ -26,21 +31,32 @@ For Windows on Windows
cmake -G "MSYS Makefiles" .. cmake -G "MSYS Makefiles" ..
make make
.. _host_linux_on_linux:
For Linux on Linux For Linux on Linux
~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~
Make a ``host/build`` direstory, then run ``cmake``
.. code:: bash .. code:: bash
cd host
mkdir build mkdir build
cd build cd build
cmake .. cmake ..
make make
.. _host_win_cross_on_linux:
For Windows cross compiling on Linux For Windows cross compiling on Linux
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Like :ref:`host_linux_on_linux`, but specifying the mingw64 toolchain in cmake
for building.
.. code:: bash .. code:: bash
cd host
mkdir build mkdir build
cd build cd build
cmake -DCMAKE_TOOLCHAIN_FILE=../toolchain-mingw64.cmake .. cmake -DCMAKE_TOOLCHAIN_FILE=../toolchain-mingw64.cmake ..
@ -49,12 +65,26 @@ For Windows cross compiling on Linux
Building the Windows installer Building the Windows installer
------------------------------ ------------------------------
Install NSIS compiler Build the host program, see above sections. Build 1. :ref:`Build <host_win_cross_on_linux>` the host for Linux.
installer with ``makensis platform/Windows/installer.nsi`` The resulting
installer will be at ``platform/Windows/looking-glass-host-setup.exe`` 2. Install ``nsis``
.. code:: bash
apt-get install nsis
3. Use ``makensis`` to build the installer.
.. code:: bash
cd host/build/platform/Windows
makensis installer.nsi
.. _host_questions: .. _host_questions:
This will build ``looking-glass-host-setup.exe`` under
``host/build/platform/Windows/looking-glass-host-setup.exe``
Questions and Answers Questions and Answers
--------------------- ---------------------