Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Change Mac OS X to macOS #1295

Merged
merged 2 commits into from
Aug 17, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/build.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@ jobs:
path: ${{github.workspace}}/build/Debug/freeciv21-client.exe
if-no-files-found: error
os_x:
name: "Mac OS X"
name: "macOS"
runs-on: macos-latest
needs: clang-format
env:
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,9 @@ Freeciv21 is maintained by folks from [longturn.net](https://longturn.net). We w
Installation
------------

### Windows and Mac OS
### Windows and macOS

We provide Windows and Mac OS installers in the **Assets** section of every [release](https://github.com/longturn/freeciv21/releases). Make sure to download the **.exe** or **.dmg** file depending on platform. After downloading, run the installer. The Windows install is [documented here](https://longturn.readthedocs.io/en/latest/General/windows-install.html).
We provide Windows and macOS installers in the **Assets** section of every [release](https://github.com/longturn/freeciv21/releases). Make sure to download the **.exe** or **.dmg** file depending on platform. After downloading, run the installer. The Windows install is [documented here](https://longturn.readthedocs.io/en/latest/General/windows-install.html).

### Linux

Expand Down
4 changes: 2 additions & 2 deletions docs/Contributing/dev-env.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ noted, that you typically only have to go through this process once unless you s
Workstation
===========

Freeciv21 can be developed on Linux, Windows and MacOS X. Any current version of these OS's is acceptible. For
Freeciv21 can be developed on Linux, Windows and macOS. Any current version of these OS's is acceptible. For
Windows, you will need to setup either the MSYS2 environment or Visual Studio to do development.
Refer to :doc:`msys2` or :doc:`Visual Studio <visual-studio>` for more information. It should be generally
understood that :strong:`Linux` is the preferred development platform. For a complete set of installation
Expand All @@ -22,7 +22,7 @@ All platforms can use `KDevelop <https://www.kdevelop.org/download>`_. However,

* On Windows, due to the nature of the integration with MSYS2, native compilation and debugging is not
supported. This is resolved with Visual Studio as the IDE.
* On MacOS X, KDevelop is still considered experimental. Many Mac users
* On macOS, KDevelop is still considered experimental. Many Mac users
use `XCode <https://developer.apple.com/xcode/>`_.

For the best results, especially if you are editing game code and not just Longturn game rulesets or
Expand Down
4 changes: 2 additions & 2 deletions docs/General/faq.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1257,8 +1257,8 @@ OK, I've downloaded and installed it, how do I run it?
See the document about :doc:`windows-install`.


Mac OS X
--------
macOS
-----

Precompiled binaries in a :file:`*.dmg` file can be downloaded from https://github.com/longturn/freeciv21/releases.

Expand Down
22 changes: 11 additions & 11 deletions docs/General/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ Installing Freeciv21
The developers of Freeciv21 provide pre-compiled binaries and installation packages for tagged releases. They
can be found on the LongTurn GitHub Repository for Freeciv21 at
https://github.com/longturn/freeciv21/releases. The LongTurn community provides binary packages for Debian
based Linux distros (Debian, Ubuntu, Mint, etc.), Microsoft Windows\ |reg| (32 and 64-bit), and Apple MacOS
X\ |reg|. If you are an Arch Linux user, you can find Freeciv21 in the AUR at
based Linux distros (Debian, Ubuntu, Mint, etc.), Microsoft Windows\ |reg| (32 and 64-bit), and Apple
macOS\ |reg|. If you are an Arch Linux user, you can find Freeciv21 in the AUR at
https://aur.archlinux.org/packages/freeciv21.

For more information on using the Windows Installer package, you can read about it at :doc:`windows-install`.
Expand All @@ -27,7 +27,7 @@ configuration process is smart enough to work out whether your system is suitabl

An operating system that support Qt
Any modern operating system that supports Qt 5.12+ is required. As of this writing this is Linux,
Microsoft Windows\ |reg| and Apple Mac OS X\ |reg|.
Microsoft Windows\ |reg| and Apple macOS\ |reg|.

Linux Distributions:

Expand All @@ -47,12 +47,12 @@ An operating system that support Qt
.. note::
The above list of Linux distributions is, of course, not exhaustive. The Freeciv21 Community has simply
listed the mainline, well supported, distributions here. The code repository has Continuous Integration
enabled and all code commits pass through Ubuntu, Mac OS and Windows for testing. It is assumed that the
enabled and all code commits pass through Ubuntu, macOS and Windows for testing. It is assumed that the
user is keeping his/her computer OS up to date. Support by the community for these distributions will be
better than for some of the others out there, so keep that in mind if you are not an experienced Linux user.

.. note::
The following instructions on this page are for Linux, MSYS2 and MacOS X environments. You will need to
The following instructions on this page are for Linux, MSYS2 and macOS environments. You will need to
:doc:`install MSYS2 <../../Contributing/msys2>` first before continuing here if using MSYS2 on Windows.
However, you can also compile on Windows with Microsoft
:doc:`Visual Studio <../../Contributing/visual-studio>`. The Visual Studio instructions are self contained.
Expand All @@ -65,7 +65,7 @@ A C and C++ compiler

Development of Freeciv21 is primarily done with :file:`gcc`, the GNU project's excellent C and C++
compiler. For complete cross-platform support the LongTurn community uses the LLVM project's
:file:`clang-cl` compiler, which is supported on Linux, Windows and Mac OS X.
:file:`clang-cl` compiler, which is supported on Linux, Windows and macOS.

The Cmake program
Freeciv21 developers generally use :file:`cmake`, the Kitware make program. You can check if you have
Expand Down Expand Up @@ -146,7 +146,7 @@ Installing Package Dependencies
See the `Debian Linux Packages`_ section below on the steps to install the components for Debian Linux and
its variants.

See the `MacOS X Packages`_ section below on the steps to install the components for Apple MacOS X.
See the `macOS Packages`_ section below on the steps to install the components for Apple macOS.

If you are running Windows and want to use the MSYS2 environment and not set it up yet, then
:doc:`do so now <../../Contributing/msys2>`, before continuing.
Expand Down Expand Up @@ -186,10 +186,10 @@ following commands:

At this point, follow the steps in `Obtaining the Source Code`_ section below.

MacOS X Packages
================
macOS Packages
==============

Below are all the command line steps needed to start with a fresh install of MacOS X.
Below are all the command line steps needed to start with a fresh install of macOS.

.. code-block:: rst

Expand Down Expand Up @@ -233,7 +233,7 @@ reading in the `Other CMake Notes`_ section below for more notes about other com
$ cmake . -B build -G Ninja


On MacOS X, you need to use a preset that is defined in the :file:`CMakePresets.json` file. When complete
On macOS, you need to use a preset that is defined in the :file:`CMakePresets.json` file. When complete
you can go to the `Compiling/Building`_ section below to continue.

.. code-block:: rst
Expand Down