.. _ref_getting_started_windows:

Windows Enviorment
==================

Setting up your development enviorment for the Windows OS is used to build LinQ Networking Applications that run on Windows 10 operating system. The Windows Development enviorment does not support running the test framework and is only supported for application development. The Windows Development enviorment may be used to build embedded linux distributions but this is not supported. For Embedded Linux target installations, please refer to setting up your Linux host machine.


Required Packages
-----------------

The following packages are required to get your Windows OS up and running. 

   *If you find any packages are missing please add them to the list by submitting a PR*

1. `Git <https://git-scm.com/download/win>`_

   .. note:: Config your git to play nice with others

      .. code-block:: bash

         git config --global core.eol lf
         git config --global core.filemode false

   .. warning:: Git For Windows does not bundle a proper version of perl that supports Windows and does not support Windows file path syntax correctly. See reference to issue `here <https://kitware.com/cmake/cmake/issues/18766>`_

      As a workaround - you should pass a proper perl binary when compiling LinQ Network with OPENSSL ssl backend. IE:

      .. code-block:: bash

         cmake -DPERL_EXECUTABLE=/c/Strawberry/perl/bin/perl.exe -DBUILD_EXAMPLES=ON -DCMAKE_INSTALL_PREFIX=./install

2. `Microsoft Visual Studio 2019 (Community Edition) <https://visualstudio.microsoft.com/vs/community>`_

3. `LLVM <https://releases.llvm.org/download.html>`_

4. `CMake <https://cmake.org/download>`_

5. `Docker Community <https://docs.docker.com/docker-for-windows/install/>`_ (Recommended for development using hardware containers)

   .. note:: Configure your docker to run Linux Containers per the Windows Docker documentation

   .. warning:: If docker does not support your Windows Installation well, try and use `Docker Toolbox <https://docs.docker.com/toolbox/toolbox_install_windows>`_


6. `Rust <https://rustup.rs>`_ (Recommended for building command line utilities and Rust bindings)

7. `NodeJS + NPM <https://nodejs.org>`_ (Recommended for building the NodeJS bindings)

8. `Go <https://golang.org>`_ (Recommended for building the Go bindings)

9. `Python <https://python.org>`_ (Recommended for building the Python bindings)

10. `Openssl <https://www.openssl.org>`_ (Recommended for building HTTP server with OpenSSL as TLS backend)

Installation
------------

The following terminal commands show how to build and install the linq-network library to the linq-network/build-windows/install directory.

.. code-block:: bash

   git clone https://bitbucket.org/Altronix/linq-network
   cd linq-network
   git submodule update --init
   mkdir build-windows
   cd build-windows
   cmake -DCMAKE_ISNTALL_PREFIX=./build-windows/install ..
   cmake --build ./build-windows --target install --config MinSizeRel

.. warning:: 
   Windows does not support the CMAKE_BUILD_TYPE flag during configuration step.  To configure the BUILD_TYPE use the --config switch during the compilation step.

.. note:: For a list of configuration options, use cmake -LH command.  See a description of the configuration parameters here: :ref:`ref_getting_started_configuration`