summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--README.md21
1 files changed, 16 insertions, 5 deletions
diff --git a/README.md b/README.md
index b59d37f..61a81a9 100644
--- a/README.md
+++ b/README.md
@@ -21,11 +21,22 @@ Some key features are:
21 21
22## Building 22## Building
23 23
24You need to have a working compiler and development environent available. 24### Quick access
25
26* [Prerequisites](#prerequisites)
27 * [Linux (Debian/Ubuntu based)](#linux-debianubuntu-based)
28 * [macOS](#macos)
29 * [Windows](#windows)
30* [Configuring the source tree](#configuring-the-source-tree)
31* [Building and installation](#building-and-installation)
25 32
26### Prerequisites 33### Prerequisites
27 34
28* #### Debian/Ubuntu based Linux 35You need to have a working compiler and development environent available. This project uses autotools
36for the build process, allowing to have common build steps regardless of the platform. Only the
37prerequisites differ and are described in this section.
38
39* #### Linux (Debian/Ubuntu based)
29 40
30 Install all required dependencies and build tools: 41 Install all required dependencies and build tools:
31 ```shell 42 ```shell
@@ -80,9 +91,9 @@ You need to have a working compiler and development environent available.
80 export PYTHON_EXTRA_LDFLAGS="-Wl,-stack_size,1000000 -framework CoreFoundation $PYTHON_FRAMEWORK_PATH" 91 export PYTHON_EXTRA_LDFLAGS="-Wl,-stack_size,1000000 -framework CoreFoundation $PYTHON_FRAMEWORK_PATH"
81 ``` 92 ```
82 93
83* #### Windows: MSYS2 94* #### Windows
84 95
85 [MSYS2](https://www.msys2.org/) is the preferred way of compiling this project on Windows. Download the MSYS2 installer 96 [MSYS2](https://www.msys2.org/) is the official way of compiling this project on Windows. Download the MSYS2 installer
86 and follow the installation steps. 97 and follow the installation steps.
87 98
88 It is recommended to use the _MSYS2 MinGW 64-bit_ shell. Run it and make sure the required dependencies are installed: 99 It is recommended to use the _MSYS2 MinGW 64-bit_ shell. Run it and make sure the required dependencies are installed:
@@ -253,5 +264,5 @@ iPadOS, tvOS, watchOS, and macOS are trademarks of Apple Inc.
253This project is an independent software library and has not been authorized, 264This project is an independent software library and has not been authorized,
254sponsored, or otherwise approved by Apple Inc. 265sponsored, or otherwise approved by Apple Inc.
255 266
256README Updated on: 2024-02-13 267README Updated on: 2024-02-16
257 268