Skip to content

Commit

Permalink
Merge pull request #510 from AllenX2018/improve-build-doc
Browse files Browse the repository at this point in the history
add MinGW build guideline and tips to disable building docs
  • Loading branch information
akheron committed Oct 24, 2019
2 parents 50c9623 + 6e211b2 commit ca88677
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions doc/gettingstarted.rst
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,11 @@ Generating make files on unix:
cd build
cmake .. # or ccmake .. for a GUI.
.. note::

If you don't want to build docs or ``Sphinx`` is not installed, you should add ``"-DJANSSON_BUILD_DOCS=OFF"`` in the ``cmake`` command.


Then to build::

make
Expand Down Expand Up @@ -115,6 +120,7 @@ Creating Visual Studio project files from the command line:
- ``Visual Studio 12 2013``
- ``Visual Studio 14 2015``
- ``Visual Studio 15 2017``
- ``Visual Studio 16 2019``

Any later version should also work.

Expand All @@ -136,6 +142,21 @@ for the project, run::

cmake -LH ..

Windows (MinGW)
^^^^^^^^^^^^^^^
If you prefer using MinGW on Windows, make sure MinGW installed and ``{MinGW}/bin`` has been added to ``PATH``, then do the following commands:

.. parsed-literal::
<unpack>
cd jansson-|release|
md build
cd build
cmake -G "MinGW Makefiles" ..
mingw32-make
Mac OSX (Xcode)
^^^^^^^^^^^^^^^
If you prefer using Xcode instead of make files on OSX,
Expand Down

0 comments on commit ca88677

Please sign in to comment.