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

Started modifying the User Manual page, and deleted the following sections: Updates for this Manual, Optimization, and Word of Warning. Added TOC (only first-level headings included, until I shorten most of the headings on the next iteration). Also, I created the Contribute to Nuitka page, but it’s not ready to see the world. To the Impressum page, I've added social media links from the User Manual. #70

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
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
1 change: 1 addition & 0 deletions _static/facebook.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions _static/mastodon.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
47 changes: 42 additions & 5 deletions _static/my_theme.css
Original file line number Diff line number Diff line change
Expand Up @@ -177,8 +177,9 @@ html {
transition: opacity 500ms;
-webkit-transition: opacity 500ms;
color: #fff;
font-size: 12px;
text-align: center;
margin-top: 7px;
font-weight: bold;
}

.social-button:hover .shares {
Expand All @@ -197,23 +198,59 @@ html {
}

.social-button.twitter {
background-color: #5BC2F0;
background-color: #fff;
border-radius: 25px;
border: 1px solid black;
}

.social-button.twitter:hover {
background-color: #000;
}

.social-button.twitter:hover .icon img {
filter: brightness(0) invert(1);
}

.social-button.mastodon {
background-color: #563ACC;
background-color: #fff;
border-radius: 25px;
border: 1px solid #6364FF ;
}

.social-button.mastodon:hover {
background-color: #6364FF;
}

.social-button.mastodon:hover .icon img {
filter: brightness(0) invert(1);
}

.social-button.reddit {
background-color: #333333;
background-color: #fff;
border-radius: 25px;
border: 1px solid #FF5700;
}

.social-button.reddit:hover {
background-color: #FF5700;
}

.social-button.reddit:hover .icon img {
filter: brightness(0) invert(1);
}

.social-button.facebook {
background-color: #435D96;
background-color: #fff;
border-radius: 25px;
border: 1px solid #1877F2;
}

.social-button.facebook:hover {
background-color: #1877F2;
}

.social-button.facebook:hover .icon img {
filter: brightness(0) invert(1);
}

.language-switcher-container {
Expand Down
1 change: 1 addition & 0 deletions _static/reddit.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions _static/x-twitter.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
16 changes: 8 additions & 8 deletions _templates/footer.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,40 +7,40 @@
<a href="https://twitter.com/share?url={{ pageurl|e }}&hashtags=nuitka" target="_blank">
<div class="social-button twitter">
<p class="icon">
<img src="/_static/icon-twitter.png" alt="Share with Twitter" width="24" height="24">
<img src="/_static/x-twitter.svg" alt="Share with Twitter" width="24" height="24">
</p>

<p class="shares">share...</p>
<p class="shares">share</p>
</div>
</a>

<a href="https://www.facebook.com/sharer.php?u={{ pageurl|e }}&hashtag=%23nuitka" target="_blank">
<div class="social-button facebook">
<p class="icon">
<img src="/_static/icon-facebook.png" alt="Share with Facebook" width="24" height="24">
<img src="/_static/facebook.svg" alt="Share with Facebook" width="15" height="15">
</p>

<p class="shares">share...</p>
<p class="shares">share</p>
</div>
</a>

<a href="https://mastodonshare.com/?url={{ pageurl|e }}" target="_blank">
<div class="social-button mastodon">
<p class="icon">
<img src="/_static/icon-mastodon.svg" alt="Share with Mastodon" width="24" height="24">
<img src="/_static/mastodon.svg" alt="Share with Mastodon" width="21" height="21">
</p>

<p class="shares">share...</p>
<p class="shares">share</p>
</div>
</a>

<a href="http://www.reddit.com/submit?url={{ pageurl|e }}" target="_blank">
<div class="social-button reddit">
<p class="icon">
<img src="/_static/icon-reddit.png" alt="Share with Reddit" width="24" height="24">
<img src="/_static/reddit.svg" alt="Share with Reddit" width="24" height="24">
</p>

<p class="shares">share...</p>
<p class="shares">share</p>
</div>
</a>

Expand Down
2 changes: 1 addition & 1 deletion doc/doc/contribute-to-nuitka.rst
Original file line number Diff line number Diff line change
Expand Up @@ -47,4 +47,4 @@ branches:
<https://nuitka.net/doc/developer-manual.html>`__ explains the coding
rules, branching model used, with feature branches and hotfix
releases, the Nuitka design and much more. Consider reading it to
become a contributor.
become a contributor. This document is intended for Nuitka users.
78 changes: 27 additions & 51 deletions doc/doc/user-manual.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +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.
Expand All @@ -15,31 +18,11 @@ license type, use cases, requirements, and credits.
:local:
:class: page-toc

Nuitka is **the** Python compiler. It is written in Python. It is a
seamless replacement or extension to the Python interpreter and compiles
**every** construct that Python 2 (2.6, 2.7) and Python 3 (3.4 - 3.11)
have, when itself run with that Python version.

It then executes uncompiled code and compiled code together in an
extremely compatible manner.

You can use all Python library modules and all extension modules freely.

Nuitka translates the Python modules into a C level program that then
uses ``libpython`` and static C files of its own to execute in the same
way as CPython does.

All optimization is aimed at avoiding overhead, where it's unnecessary.
None is aimed at removing compatibility, although slight improvements
will occasionally be done, where not every bug of standard Python is
emulated, e.g. more complete error messages are given, but there is a
full compatibility mode to disable even that.

**************
Requirements
**************

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

.. contents::
Expand All @@ -52,45 +35,38 @@ C Compiler
You need a C compiler with support for C11 or alternatively a C++
compiler for C++03 [#]_.

Currently, this means, you need to use one of these compilers:

- The MinGW64 C11 compiler, on Windows, 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.
**For Windows**, use one of the following compilers:

- Visual Studio 2022 or higher on Windows [#]_. English language pack
for best results (Nuitka filters away garbage outputs, but only for
English language). It will be used by default if installed.
- 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.

- On all other platforms, the ``gcc`` compiler of at least version 5.1,
and below that the ``g++`` compiler of at least version 4.4 as an
alternative.
- 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`` compiler on macOS X and most FreeBSD architectures.

- On Windows, the ``clang-cl`` compiler on Windows can be used if
provided by the Visual Studio installer.

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

Support for this C11 is given with gcc 5.x or higher or any clang
version.
**For macOS**, use the **Clang** compiler. It's also compatible with
most **FreeBSD** architectures.

The older MSVC compilers don't do it yet. But as a workaround, with
Python 3.10 or older, the C++03 language standard is significantly
overlapping with C11, it is then used instead.
**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.

.. [#]

Download for free from
https://www.visualstudio.com/en-us/downloads/download-visual-studio-vs.aspx
(the community editions work just fine).
Support for this **C11** is given with **gcc 5.x** or higher or any
**clang** version.

The latest version is recommended, but not required. On the other hand,
there is no need to except to support pre-Windows 10 versions, and they
might work for you, but support of these configurations is only
available to commercial users.
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
1 change: 1 addition & 0 deletions update.py
Original file line number Diff line number Diff line change
Expand Up @@ -879,6 +879,7 @@ def runPostProcessing():
<ul>
<li>
<div class="logo_container">
<a href="https://nuitka.net">
<img src="/_static/Nuitka-Logo-Symbol.svg" class="logo" alt="Logo" width="28" height="28"
</a>
</div>
Expand Down