[gtk-web/new-website] Reformat the installation pages
- From: Emmanuele Bassi <ebassi src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gtk-web/new-website] Reformat the installation pages
- Date: Thu, 30 Jan 2020 09:10:57 +0000 (UTC)
commit 6c51689eb5396335d29fc6712d1d88b40f1ed2b2
Author: Emmanuele Bassi <ebassi gnome org>
Date: Thu Jan 30 09:52:11 2020 +0100
Reformat the installation pages
Minor fixes in the style and content.
collections/_docs/installations.md | 18 +++--
collections/_docs/linux.md | 19 ++++--
collections/_docs/macos.md | 52 ++++++++++++---
collections/_docs/windows.md | 131 ++++++++++++++++++++++++++++---------
4 files changed, 169 insertions(+), 51 deletions(-)
---
diff --git a/collections/_docs/installations.md b/collections/_docs/installations.md
index 6bae16e..a552c36 100644
--- a/collections/_docs/installations.md
+++ b/collections/_docs/installations.md
@@ -11,24 +11,32 @@ GTK is available on:
## Unstable releases
-The latest unstable tarballs can be downloaded from
[download.gnome.org](http://download.gnome.org/sources/gtk+/).
+The latest unstable tarballs can be downloaded from
+[download.gnome.org](http://download.gnome.org/sources/gtk+/).
## Bleeding edge
-Alternatively, you can check out the latest unstable release of GTK using git.
+Alternatively, you can check out the latest unstable release of GTK using
+git.
```
git clone https://gitlab.gnome.org/GNOME/gtk.git
```
-If you plan on pushing changes back upstream and have a GNOME account, use the following instead:
+If you plan on pushing changes back upstream and have a GNOME account, use
+the following instead:
```
git clone git gitlab gnome org:GNOME/gtk.git
```
-For more information on this, see the instructions on [how to use the
repository](https://wiki.gnome.org/GitLab).
+For more information on this, see the instructions on
+[how to use the repository](https://wiki.gnome.org/GitLab).
## Repository Browser
-You can also download the dependencies from their git repository from your web browser for
[gtk](https://gitlab.gnome.org/GNOME/gtk), [glib](https://git.gnome.org/browse/glib),
[pango](https://git.gnome.org/browse/pango), [gdk-pixbuf](https://git.gnome.org/browse/gdk-pixbuf) and
[atk](https://git.gnome.org/browse/atk).
\ No newline at end of file
+You can also download the dependencies from their git repository from your
+web browser for [gtk](https://gitlab.gnome.org/GNOME/gtk),
+[glib](https://git.gnome.org/browse/glib), [pango](https://git.gnome.org/browse/pango),
+[gdk-pixbuf](https://git.gnome.org/browse/gdk-pixbuf) and
+[atk](https://git.gnome.org/browse/atk).
diff --git a/collections/_docs/linux.md b/collections/_docs/linux.md
index af304e3..0e16216 100644
--- a/collections/_docs/linux.md
+++ b/collections/_docs/linux.md
@@ -5,9 +5,12 @@ permalink: /docs/installations/:name/
-In order to install GTK for GNU/Linux and Unix systems, you will need to get the GLib,
GObject-Introspection, Pango, Gdk-Pixbuf, ATK and GTK packages to build GTK. To read more about these
packages, please refer to the [Architecture](/docs/architecture/).
+In order to install GTK for GNU/Linux and Unix systems, you will need to get
+the GLib, GObject-Introspection, Pango, Gdk-Pixbuf, ATK and GTK packages to
+build GTK. To read more about these packages, please refer to the
+[Architecture](/docs/architecture/).
-To build an environment for GTK, install all te dependencies listed below:
+To build an environment for GTK, install all the dependencies listed below:
Dependency | Version | Source
--- | --- | :---:
@@ -18,11 +21,17 @@ Gdk-pixbuf | 2.38 | [<i class="fas fa-download"></i>](http://ftp.gnome.org/pub/g
ATK | 2.26 | [<i class="fas fa-download"></i>](http://ftp.gnome.org/pub/gnome/sources/atk/2.26/)
GObject-Introspection | 1.60 | [<i class="fas
fa-download"></i>](http://ftp.gnome.org/pub/gnome/sources/gobject-introspection/1.60/)
-To build GTK 3.24, see the [installation guide](https://developer.gnome.org/gtk3/stable/gtk-building.html).
For additional help, [FAQ](https://developer.gnome.org/gtk3/stable/gtk-question-index.html) is a good
starting point.
+To build GTK 3.24, see the [installation
+guide](https://developer.gnome.org/gtk3/stable/gtk-building.html). For
+additional help,
+[FAQ](https://developer.gnome.org/gtk3/stable/gtk-question-index.html) is a
+good starting point.
## Older Versions
-Some applications still require GTK 2, an older stable version of GTK. You can have the run-time and
development environments for GTK 3.x, GTK 2.x and GTK 1.2 installed simultaneously on your computer.
+Some applications still require GTK 2, an older stable version of GTK. You
+can have the run-time and development environments for GTK 3.x, GTK 2.x and
+GTK 1.2 installed simultaneously on your computer.
### GTK v3.x
@@ -51,4 +60,4 @@ GTK 2.24 | [Sources](http://ftp.gnome.org/pub/gnome/sources/gtk+/2.24/)
Version | Packages
--- | ---
-GTK 1.2 | [Sources](http://ftp.gnome.org/pub/gnome/sources/gtk+/1.2/)
\ No newline at end of file
+GTK 1.2 | [Sources](http://ftp.gnome.org/pub/gnome/sources/gtk+/1.2/)
diff --git a/collections/_docs/macos.md b/collections/_docs/macos.md
index 29c68d3..b46e558 100644
--- a/collections/_docs/macos.md
+++ b/collections/_docs/macos.md
@@ -7,11 +7,19 @@ permalink: /docs/installations/:name/
## About
-Do you have a favorite GTK application that you'd like to run on your Mac with a more Mac-like look and
feel, with the menus up on the menu bar and standard Mac keyboard shortcuts like Command-Q? Perhaps you
maintain a GTK application and want to expand your user base to Mac users who want a Mac experience, not a
transplanted Unix experience?
+Do you have a favorite GTK application that you'd like to run on your Mac
+with a more Mac-like look and feel, with the menus up on the menu bar and
+standard Mac keyboard shortcuts like Command-Q? Perhaps you maintain a GTK
+application and want to expand your user base to Mac users who want a Mac
+experience, not a transplanted Unix experience?
## Features
-Linking with GTK's [Quartz backend](https://wiki.gnome.org/Projects/GTK/OSX) connects your application to
the Mac's native display manager, keyboard, and pointing device. With a little extra code and
[gtk-mac-integration](https://wiki.gnome.org/Projects/GTK/OSX/Integration) you can:
+Linking with GTK's [Quartz backend](https://wiki.gnome.org/Projects/GTK/OSX)
+connects your application to the Mac's native display manager, keyboard, and
+pointing device. With a little extra code and
+[gtk-mac-integration](https://wiki.gnome.org/Projects/GTK/OSX/Integration)
+you can:
* **Integrate** the Application's menus with the Mac Menubar.
* **Manipulate** your application's dock tile.
@@ -20,28 +28,54 @@ Linking with GTK's [Quartz backend](https://wiki.gnome.org/Projects/GTK/OSX) con
## Requirements
-There are a number of requirements that need to be met by your system before you can build for OSX. These
are updated from time to time and kept on the live wiki.
+There are a number of requirements that need to be met by your system before
+you can build for OSX. These are updated from time to time and kept on the
+live wiki.
## Building
-[Building](https://wiki.gnome.org/Projects/GTK/OSX/Building) with
[jhbuild](https://wiki.gnome.org/Projects/Jhbuild) and the GTK-OSX modulesets, you can build your application
and all of its dependent libraries with a single command.
+[Building](https://wiki.gnome.org/Projects/GTK/OSX/Building) with
+[jhbuild](https://wiki.gnome.org/Projects/Jhbuild) and the GTK-OSX
+modulesets, you can build your application and all of its dependent
+libraries with a single command.
## All-in-one bundles
-[Bundling](https://wiki.gnome.org/Projects/GTK/OSX/Bundling) with the gtk-mac-bundler, an easily configured
python program which creates an application bundle for you and populates it with your application executable
and all of the dependent libraries from your GTK build, changing the installed names as needed to point
inside the bundle.
+[Bundling](https://wiki.gnome.org/Projects/GTK/OSX/Bundling) with the
+gtk-mac-bundler, an easily configured python program which creates an
+application bundle for you and populates it with your application executable
+and all of the dependent libraries from your GTK build, changing the
+installed names as needed to point inside the bundle.
## Getting Started
-First, make sure that your system meets the requirements as mentioned above, then download and run the
[installation script](http://git.gnome.org/browse/gtk-osx/plain/gtk-osx-build-setup.sh)
(gtk-osx-build-setup.sh). If your application already has a module, everything you need to build your
application is handled by jhbuild. The build page has detailed instructions.
+First, make sure that your system meets the requirements as mentioned above,
+then download and run the [installation
+script](http://git.gnome.org/browse/gtk-osx/plain/gtk-osx-build-setup.sh)
+(gtk-osx-build-setup.sh). If your application already has a module,
+everything you need to build your application is handled by jhbuild. The
+build page has detailed instructions.
## Success Stories
-Some of the projects which have used GTK on Mac OS X have shared their
[experiences](https://wiki.gnome.org/Projects/GTK/OSX/PortedApps) for all to see. If you have any feedback
you would like to give about your experiences here, please contact us on the the users mailing list as
mentioned below.
+Some of the projects which have used GTK on Mac OS X have shared their
+[experiences](https://wiki.gnome.org/Projects/GTK/OSX/PortedApps) for all to
+see. If you have any feedback you would like to give about your experiences
+here, please contact us on the the users mailing list as mentioned below.
## Mailing lists & web forum
-Support for building, bundling, and the integration library is provided by a [mailing
list](http://mail.gnome.org/mailman/listinfo/gtk-osx-users-list) and a
[forum](http://sourceforge.net/apps/phpbb/gtk-osx/). Contributers may wish to subscribe to the [developer's
mailing list](http://mail.gnome.org/mailman/listinfo/gtk-osx-devel-list) as well.
+Support for building, bundling, and the integration library is provided by a
+[mailing list](http://mail.gnome.org/mailman/listinfo/gtk-osx-users-list)
+and a [forum](http://sourceforge.net/apps/phpbb/gtk-osx/). Contributers may
+wish to subscribe to the [developer's mailing
+list](http://mail.gnome.org/mailman/listinfo/gtk-osx-devel-list) as well.
## Contributing
-Bugs, patches and enhancements for building, integration, or bundling may be submitted to [Bugzilla, with
Product=gtk-mac-integration](https://bugzilla.gnome.org/enter_bug.cgi?product=gtk-mac-integration). Bug
reports on any other package, including GTK itself, should be submitted against that package, not
gtk-mac-integration; the GTK component for the Quartz backend is "Backend: Quartz".
+Bugs, patches and enhancements for building, integration, or bundling may be
+submitted to [Bugzilla, with
+Product=gtk-mac-integration](https://bugzilla.gnome.org/enter_bug.cgi?product=gtk-mac-integration).
+Bug reports on any other package, including GTK itself, should be submitted
+against that package, not gtk-mac-integration; the label for the Quartz
+backend is "macOS".
diff --git a/collections/_docs/windows.md b/collections/_docs/windows.md
index 31ab7cf..bc00e28 100644
--- a/collections/_docs/windows.md
+++ b/collections/_docs/windows.md
@@ -5,30 +5,57 @@ permalink: /docs/installations/:name/
-> Note: These instructions are intended for developers wanting to create Windows applications based on GTK,
not for end-users. On Windows, GTK applications are typically bundled with GTK already, so end-users do not
need to worry about how to install GTK itself.
+> Note: These instructions are intended for developers wanting to create
+> Windows applications based on GTK, not for end-users. On Windows, GTK
+> applications are typically bundled with GTK already, so end-users do not
+> need to worry about how to install GTK itself.
There are two methods to install GTK on Windows development machines.
* ### [First Method](#using-gtk-from-vcpkg-packages)
- This method is based on the packages available from the [Microsoft vcpkg
project](https://docs.microsoft.com/en-us/cpp/vcpkg), which are built using Visual Studio, and therefore work
well if you intend to develop using that platform.
+ This method is based on the packages available from the
+ [Microsoft vcpkg project](https://docs.microsoft.com/en-us/cpp/vcpkg),
+ which are built using Visual Studio, and therefore work well if you intend
+ to develop using that platform.
* ### [Second Method](#using-gtk-from-msys2-packages)
- This method is based on the packages provided by [MSYS2](https://www.msys2.org/), which provides a
UNIX-like environment for Windows. Both of these repositories also provide packages for a large number of
other useful open source libraries.
-
-If you really want to build GTK from the pristine sources yourself, you can use the project files for
Microsoft Visual Studio provided by the GTK releases. Learn more on [how to build the GTK stack using
Microsoft Visual Studio](https://wiki.gnome.org/Projects/GTK/Win32/MSVCCompilationOfGTKStack) and read these
other tips on [how to build GTK with MSVC on
Windows](https://blogs.gnome.org/nacho/2015/02/19/building-gtk-3-with-msvc-2013/). In almost all cases, using
the packages from `vcpkg` or `MSYS2` is much simpler though.
-
-We assume that you are using Windows 7 or later. For older versions of Windows, you will need to do a custom
build of older versions of GLib and GTK.
+ This method is based on the packages provided by [MSYS2](https://www.msys2.org/),
+ which provides a UNIX-like environment for Windows. Both of these repositories
+ also provide packages for a large number of other useful open source libraries.
+
+If you really want to build GTK from the pristine sources yourself, you can
+use the project files for Microsoft Visual Studio provided by the GTK
+releases. Learn more on [how to build the GTK stack using Microsoft Visual
+Studio](https://wiki.gnome.org/Projects/GTK/Win32/MSVCCompilationOfGTKStack)
+and read these other tips on [how to build GTK with MSVC on
+Windows](https://blogs.gnome.org/nacho/2015/02/19/building-gtk-3-with-msvc-2013/).
+In almost all cases, using the packages from `vcpkg` or `MSYS2` is much
+simpler though.
+
+We assume that you are using Windows 7 or later. For older versions of
+Windows, you will need to do a custom build of older versions of GLib and
+GTK.
## Using GTK from vcpkg packages
<div class="alert alert-warning">
-WARNING: The `vcpkg` packaging is not maintained by the GTK team, and it uses a different build system than
the one used by GTK. If something breaks when building GTK or its dependencies using `vcpkg`, make sure to
open an issue in the [vcpkg issue tracker](https://github.com/Microsoft/vcpkg/issues), instead of the GTK one.
+WARNING: The `vcpkg` packaging is not maintained by the GTK team, and it uses
+a different build system than the one used by GTK. If something breaks when
+building GTK or its dependencies using `vcpkg`, make sure to open an issue in
+the [vcpkg issue tracker](https://github.com/Microsoft/vcpkg/issues), instead
+of the GTK one.
</div>
### Installation
-The GTK library, as well as all pre-requisites and many language bindings (e.g. the C++ bindings gtkmm) are
packaged by the Microsoft `vcpkg` project for use with Visual Studio. This provides a very simple way to
setup a development environment to create GTK apps. If you prefer a more UNIX-like experience, building from
the command line instead of using Visual Studio, you may want to consider installing GTK from MSYS2 instead.
+The GTK library, as well as all pre-requisites and many language bindings
+(e.g. the C++ bindings gtkmm) are packaged by the Microsoft `vcpkg` project
+for use with Visual Studio. This provides a very simple way to setup a
+development environment to create GTK apps. If you prefer a more UNIX-like
+experience, building from the command line instead of using Visual Studio,
+you may want to consider installing GTK from MSYS2 instead.
-In order to use `vcpkg` packages, you first need to clone the `vcpkg` repository,
+In order to use `vcpkg` packages, you first need to clone the `vcpkg`
+repository,
```
git clone https://github.com/Microsoft/vcpkg
@@ -37,23 +64,34 @@ cd vcpkg
vcpkg install gtk:x64-windows
```
-The part behind the colon ':' specifies the target. After this step, any project created in Visual Studio
will now automatically see the GTK libraries.
+The part behind the colon ':' specifies the target. After this step, any
+project created in Visual Studio will now automatically see the GTK
+libraries.
-If you build from the command line using `CMake`, you need to tell `CMake` where to find the libraries. This
is done by adding
+If you build from the command line using `CMake`, you need to tell `CMake`
+where to find the libraries. This is done by adding
`-DCMAKE_TOOLCHAIN_FILE=[vcpkg root]\scripts\buildsystems\vcpkg.cmake`
-to the CMake options, where `vcpkg` root is the location where you cloned the `vcpkg` repository.
+to the CMake options, where `vcpkg` root is the location where you cloned
+the `vcpkg` repository.
### Building and distributing your application
<div class="alert alert-success">
-Once you have installed the GTK as above, you should have little problem compiling a GTK app. In order to
run it successfully, you will also need a GTK theme. There is some old builtin support for a Windows theme in
GTK, but that makes your app look like a Windows 7 app. It is better to get a Windows 10 theme, for instance
the [Windows 10 Transformation Pack](https://github.com/B00merang-Project/Windows-10).
+Once you have installed the GTK as above, you should have little problem
+compiling a GTK app. In order to run it successfully, you will also need
+a GTK theme. There is some old builtin support for a Windows theme in GTK,
+but that makes your app look like a Windows 7 app. It is better to get a
+Windows 10 theme, for instance the
+[Windows 10 Transformation Pack](https://github.com/B00merang-Project/Windows-10).
</div>
-**Step 1.** Copy the `gtk-3.20` folder of that repository to a folder `share/themes/Windows10/gtk-3.0/` in
your installation folder.
+**Step 1.** Copy the `gtk-3.20` folder of that repository to a folder
+`share/themes/Windows10/gtk-3.0/` in your installation folder.
-**Step 2.** You also need to copy the icons from the Adwaita theme, which you can get from Linux box, where
they are stored in `/usr/share/icons/Adwaita/`; copy this entire folder to a share/icons folder in your
installation folder.
+**Step 2.** You also need to copy the icons from the Adwaita theme, which
+you can download from [the GNOME sources](https://download.gnome.org/sources/adwaita-icon-theme/).
**Step 3.** Perform the same steps for the `hicolor icons`.
@@ -65,21 +103,35 @@ gtk-theme-name=Windows10
gtk-font-name=Segoe UI 9
```
-**Step 5.** And to top it all off, find the `gschemas.compiled` file in `/usr/share/glib-2.0/schemas/` and
copy that to `share/glib-2.0/schemas`.
+**Step 5.** And to top it all off, run the `glib-compile-schemas` utility to
+generate the compiled settings schema in your installation folder:
+```
+glib-compile-schemas share/glib-2.0/schemas
+```
-**Step 6.** You can then zip up your installation folder, or use an installer generator to do that for you,
and distribute the result.
+**Step 6.** You can then zip up your installation folder, or use an installer
+generator to do that for you, and distribute the result.
## Using GTK from MSYS2 packages
### Installation
-The [MSYS2](https://msys2.github.io/) project provides a UNIX-like development environment for Windows. It
provides packages for many software applications and libraries, including the GTK stack. If you prefer
developing using Visual Studio, you may be better off installing GTK from vcpkg instead.
+The [MSYS2](https://msys2.github.io/) project provides a UNIX-like
+development environment for Windows. It provides packages for many software
+applications and libraries, including the GTK stack. If you prefer
+developing using Visual Studio, you may be better off installing GTK from
+vcpkg instead.
-In MSYS2 packages are installed using the [pacman package
manager](https://github.com/msys2/msys2/wiki/MSYS2-installation#iv-general-package-management).
+In MSYS2 packages are installed using the [pacman package
+manager](https://github.com/msys2/msys2/wiki/MSYS2-installation#iv-general-package-management).
-> Note: in the following steps, we will assume you're using a `64-bit Windows`. Therefore, the package names
include the x86_64 architecture identifier. If you're using a 32-bit Windows, please adapt the instructions
below using the i686 architecture identifier.
+> Note: in the following steps, we will assume you're using a `64-bit
+> Windows`. Therefore, the package names include the x86_64 architecture
+> identifier. If you're using a 32-bit Windows, please adapt the
+> instructions below using the i686 architecture identifier.
-**Step 1.**: Download the [MSYS2 installer](https://www.msys2.org/) that matches your platform and follow
the installation instructions.
+**Step 1.**: Download the [MSYS2 installer](https://www.msys2.org/) that
+matches your platform and follow the installation instructions.
**Step 2.**: Install GTK3 and its dependencies. Open a MSYS2 shell, and run:
@@ -87,21 +139,27 @@ In MSYS2 packages are installed using the [pacman package manager](https://githu
pacman -S mingw-w64-x86_64-gtk3
```
-**Step 3. (recommended)**: Install the GTK core applications. `Glade` is a GUI designer for GTK. It lets you
design your GUI and export it in XML format. You can then import your GUI from your code using the GtkBuilder
API. Read the GtkBuilder section in the GTK manual for more information.
+**Step 3. (recommended)**: Install the GTK core applications. `Glade` is a
+GUI designer for GTK. It lets you design your GUI and export it in XML
+format. You can then import your GUI from your code using the GtkBuilder
+API. Read the GtkBuilder section in the GTK manual for more information.
To install Glade:
```
pacman -S mingw-w64-x86_64-glade
```
-`Devhelp` is a help browser. It lets you easily navigate offline in the GTK, glib and gobject API help
relative to the version of these libraries installed on your system.
+`Devhelp` is a help browser. It lets you easily navigate offline in the GTK,
+glib and gobject API help relative to the version of these libraries
+installed on your system.
To install Devhelp:
```
pacman -S mingw-w64-x86_64-devhelp
```
-**Step 4. (optional)**: If you want to develop a GTK3 application in Python, you need to install the Python
bindings.
+**Step 4. (optional)**: If you want to develop a GTK3 application in Python,
+you need to install the Python bindings.
If you develop in Python 3:
```
@@ -113,17 +171,26 @@ If you develop in Python 2:
pacman -S mingw-w64-x86_64-python2-gobject
```
-**Step 5. (optional)**: Install the build tools. If you want to develop a GTK3 application in other
languages like C, C++, Fortran, etc, you'll need a compiler like gcc and other development tools:
-```
-pacman -S mingw-w64-x86_64-toolchain base-devel
-```
+**Step 5. (optional)**: Install the build tools. If you want to develop a
+GTK3 application in other languages like C, C++, Fortran, etc, you'll need a
+compiler like gcc and other development tools: ``` pacman -S
+mingw-w64-x86_64-toolchain base-devel ```
### Building and distributing your application
-You may use MSYS2 to [build your GTK application and create an installer to distribute
it](https://blogs.gnome.org/nacho/2014/08/01/how-to-build-your-gtk-application-on-windows/). Your installer
will need to ship your application build artifacts as well as GTK binaries and runtime dependencies; see the
instructions above for vcpkg for more details.
+You may use MSYS2 to [build your GTK application and create an installer to
+distribute it](https://blogs.gnome.org/nacho/2014/08/01/how-to-build-your-gtk-application-on-windows/).
+Your installer will need to ship your application build artifacts as well as
+GTK binaries and runtime dependencies; see the instructions above for vcpkg
+for more details.
## Legal notes on distributing GTK with your application
-You are welcome to redistribute GTK binaries, including applications that bundle them, on other web sites,
CD-ROM, and other media. You don't have to ask for permission. That's one of the points of Free Software.
+You are welcome to redistribute GTK binaries, including applications that
+bundle them, on other web sites, CD-ROM, and other media. You don't have to
+ask for permission. That's one of the points of Free Software.
-One important thing that the [GNU licenses](http://www.fsf.org/licenses/licenses.html) require is that you
must also redistribute the source code. This usually means at least the gettext, GLib, GTK, Pango and ATK
sources.
\ No newline at end of file
+One important thing that the [GNU
+licenses](http://www.fsf.org/licenses/licenses.html) require is that you
+must also redistribute the source code on request. This usually means at
+least the gettext, GLib, GTK, Pango and ATK sources.
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
