Skip to content

Commit ca88677

Browse files
authored
Merge pull request #510 from AllenX2018/improve-build-doc
add MinGW build guideline and tips to disable building docs
2 parents 50c9623 + 6e211b2 commit ca88677

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

doc/gettingstarted.rst

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,11 @@ Generating make files on unix:
8484
cd build
8585
cmake .. # or ccmake .. for a GUI.
8686
87+
.. note::
88+
89+
If you don't want to build docs or ``Sphinx`` is not installed, you should add ``"-DJANSSON_BUILD_DOCS=OFF"`` in the ``cmake`` command.
90+
91+
8792
Then to build::
8893

8994
make
@@ -115,6 +120,7 @@ Creating Visual Studio project files from the command line:
115120
- ``Visual Studio 12 2013``
116121
- ``Visual Studio 14 2015``
117122
- ``Visual Studio 15 2017``
123+
- ``Visual Studio 16 2019``
118124

119125
Any later version should also work.
120126

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

137143
cmake -LH ..
138144

145+
Windows (MinGW)
146+
^^^^^^^^^^^^^^^
147+
If you prefer using MinGW on Windows, make sure MinGW installed and ``{MinGW}/bin`` has been added to ``PATH``, then do the following commands:
148+
149+
.. parsed-literal::
150+
151+
<unpack>
152+
cd jansson-|release|
153+
154+
md build
155+
cd build
156+
cmake -G "MinGW Makefiles" ..
157+
mingw32-make
158+
159+
139160
Mac OSX (Xcode)
140161
^^^^^^^^^^^^^^^
141162
If you prefer using Xcode instead of make files on OSX,

0 commit comments

Comments
 (0)