diff options
| author | Petri Lehtinen <petri@digip.org> | 2019-10-24 11:23:00 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-10-24 11:23:00 +0300 |
| commit | ca88677bdd9ca6f1f22cd20030f93e81694c78d7 (patch) | |
| tree | c7837901db85c7f7620b0d07cfa74b23cad4fdbe /doc | |
| parent | 50c9623e37de498db1e9680e2eca6aa259176f40 (diff) | |
| parent | 6e211b24fe6e7270b610f0c3a98a88a87a17d8b4 (diff) | |
| download | jansson-ca88677bdd9ca6f1f22cd20030f93e81694c78d7.zip jansson-ca88677bdd9ca6f1f22cd20030f93e81694c78d7.tar.gz jansson-ca88677bdd9ca6f1f22cd20030f93e81694c78d7.tar.bz2 | |
Merge pull request #510 from AllenX2018/improve-build-doc
add MinGW build guideline and tips to disable building docs
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/gettingstarted.rst | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/doc/gettingstarted.rst b/doc/gettingstarted.rst index 64bec43..4cd1977 100644 --- a/doc/gettingstarted.rst +++ b/doc/gettingstarted.rst @@ -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 @@ -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. @@ -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, |