Skip to content

Commit 16d0400

Browse files
committed
update install documentation to use swig version 4 or higher
We are not testing against swig version 3.x. Thus, we shouldn't claim we are keeping compatibility with that older version of swig.
1 parent d892753 commit 16d0400

File tree

3 files changed

+4
-5
lines changed

3 files changed

+4
-5
lines changed

docs/source/Install/installOnLinux.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ In order to run Basilisk, the following software will be necessary. This documen
1818

1919
- .. include:: ../bskPkgRequired.txt
2020

21-
- `SWIG <http://www.swig.org/>`__ (version 3 or 4)
21+
- `SWIG <http://www.swig.org/>`__ (version 4.x)
2222
- `GCC <https://gcc.gnu.org/>`__
2323
- (Optional) Get the `GitKraken <https://www.gitkraken.com>`__
2424
application to be able to pull and manage a copy of Basilisk

docs/source/Install/installOnMacOS.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ Install HomeBrew Support Packages
5656
#. Install `HomeBrew <http://brew.sh>`__ using a Terminal window and
5757
pasting the install script from the HomeBrew web site.
5858

59-
#. The new SWIG version 4 is compatible with Basilisk. Install the SWIG software package using::
59+
#. SWIG version 4.X is compatible with Basilisk. Install the SWIG software package using::
6060

6161
$ brew install swig
6262

@@ -65,7 +65,6 @@ Install HomeBrew Support Packages
6565
$ brew install cmake
6666
$ brew link cmake
6767

68-
You need at least version 3.14 or higher.
6968

7069
Setting up the Python Environment
7170
---------------------------------

docs/source/Install/installOnWindows.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ In order to run Basilisk, the following software will be necessary:
1818
- `Python <https://www.python.org/downloads/windows/>`__ 3.8.x or greater
1919
- `pip <https://pip.pypa.io/en/stable/installing/>`__
2020
- Visual Studios 15 2017 or greater
21-
- `Swig <http://www.swig.org/download.html>`__ version 3 or 4
21+
- `Swig <http://www.swig.org/download.html>`__ version 4.X
2222
- (Optional) A GiT GUI application such as `GitKraken <https://www.gitkraken.com>`__
2323
to manage your copy of the Basilisk repository
2424

@@ -53,7 +53,7 @@ required to place accurate breakpoints/attach a debugger to C/C++ code.
5353

5454
Install Swig
5555
~~~~~~~~~~~~
56-
The standard windows swig version 3 or 4 is suitable for Basilisk (see `Configuration
56+
The standard windows swig version 4 is suitable for Basilisk (see `Configuration
5757
Instructions <http://www.swig.org/Doc1.3/Windows.html#Windows_swig_exe>`__).
5858
Download the swig zip file, which includes ``swig.exe`` file, and unzip it into somewhere like ``C:/Program Files/Swig``
5959

0 commit comments

Comments
 (0)