Skip to content

Commit

Permalink
autoformat
Browse files Browse the repository at this point in the history
  • Loading branch information
marta-matvii committed Mar 11, 2024
1 parent cb0f17f commit bac65e0
Showing 1 changed file with 27 additions and 15 deletions.
42 changes: 27 additions & 15 deletions doc/doc/user-manual.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@
Nuitka User Manual
####################

This page is the recommended first read when you start using **Nuitka**. On this page, you will learn more about **Nuitka** fundamentals, such as license type, use cases, requirements, and credits.
This page is the recommended first read when you start using **Nuitka**.
On this page, you will learn more about **Nuitka** fundamentals, such as
license type, use cases, requirements, and credits.

.. contents:: Table of Contents
:depth: 1
Expand All @@ -17,7 +19,8 @@ This page is the recommended first read when you start using **Nuitka**. On this
Requirements
**************

To ensure smooth work of **Nuitka**, make sure to follow system requirements, that include the following components:
To ensure smooth work of **Nuitka**, make sure to follow system
requirements, that include the following components:

.. contents::
:depth: 1
Expand All @@ -31,27 +34,36 @@ compiler for C++03 [#]_.

**For Windows**, use one of the following compilers:

- The **MinGW64 C11** compiler must be based on **gcc 11.2** or higher. It will be automatically downloaded if no usable C compiler
is found, which is the recommended way of installing it, as Nuitka
will also upgrade it for you.
- The **MinGW64 C11** compiler must be based on **gcc 11.2** or higher.
It will be automatically downloaded if no usable C compiler is found,
which is the recommended way of installing it, as Nuitka will also
upgrade it for you.

- The **Community** edition of `Visual Studio 2022 <https://www.visualstudio.com/en-us/downloads/download-visual-studio-vs.aspx>`_ or higher. Older versions will work, but only supported for commercial users. Use the default English language pack to enable **Nuitka** to filter away irrelevant outputs.
- The **Community** edition of `Visual Studio 2022
<https://www.visualstudio.com/en-us/downloads/download-visual-studio-vs.aspx>`_
or higher. Older versions will work, but only supported for
commercial users. Use the default English language pack to enable
**Nuitka** to filter away irrelevant outputs.

- The **Clang-cl** compiler can be used if provided by the **Visual Studio** installer.
- The **Clang-cl** compiler can be used if provided by the **Visual
Studio** installer.

**For macOS**, use the **Clang** compiler. It's also compatible with most **FreeBSD** architectures.
**For macOS**, use the **Clang** compiler. It's also compatible with
most **FreeBSD** architectures.

**For other platforms**, use the **GCC** compiler of at least version 5.1, and below that the **G++** compiler of at least version 4.4 as an alternative.
**For other platforms**, use the **GCC** compiler of at least version
5.1, and below that the **G++** compiler of at least version 4.4 as an
alternative.

.. [#]
Support for this **C11** is given with **gcc 5.x** or higher or any **clang**
version.
Support for this **C11** is given with **gcc 5.x** or higher or any
**clang** version.
The **MSVC** compiler doesn't do it yet. But as a workaround, as the C++03
language standard is significantly overlapping with C11, it is then used
instead where the C compiler is too old. Nuitka used to require a C++
compiler in the past, but it changed.
The **MSVC** compiler doesn't do it yet. But as a workaround, as the
C++03 language standard is significantly overlapping with C11, it is
then used instead where the C compiler is too old. Nuitka used to
require a C++ compiler in the past, but it changed.
Python
======
Expand Down

0 comments on commit bac65e0

Please sign in to comment.