diff options
author | Jaakko Keränen <jaakko.keranen@iki.fi> | 2021-07-14 21:01:01 +0300 |
---|---|---|
committer | Jaakko Keränen <jaakko.keranen@iki.fi> | 2021-07-14 21:01:01 +0300 |
commit | 4a74ae18b9ae0c6d6e4205a5a9852edb67808a95 (patch) | |
tree | f861bf9e46c190c6bb2958cbbe66248c06c25f4c | |
parent | 559927aa198bf062e32b5fe55431dfb7942d40f2 (diff) |
Updated README and release notes
Details about HarfBuzz and FriBidi.
-rw-r--r-- | README.md | 39 | ||||
-rw-r--r-- | res/about/help.gmi | 5 | ||||
-rw-r--r-- | res/about/version.gmi | 27 |
3 files changed, 56 insertions, 15 deletions
@@ -8,14 +8,14 @@ Like Gemini, Lagrange has been designed with minimalism in mind. It depends on a | |||
8 | 8 | ||
9 | ## Features | 9 | ## Features |
10 | 10 | ||
11 | * Beautiful typography using Unicode fonts | 11 | * Beautiful typography with full Unicode support |
12 | * Autogenerated page style and Unicode icon for each Gemini domain | 12 | * Autogenerated page style and symbol for each Gemini domain |
13 | * Smart suggestions when typing the URL — search bookmarks, history, identities | 13 | * Smart suggestions when typing the URL — search bookmarks, history, identities |
14 | * Sidebar for page outline, managing bookmarks and identities, and viewing history | 14 | * Sidebar for page outline, managing bookmarks and identities, and viewing history |
15 | * Multiple tabs | 15 | * Multiple tabs |
16 | * Identity management — create and use TLS client certificates | 16 | * Identity management — create and use TLS client certificates |
17 | * Audio playback: MP3, Ogg Vorbis, WAV | 17 | * Audio playback: MP3, Ogg Vorbis, WAV |
18 | * And more! Open `about:help` in the app, or see [help.gmi](https://git.skyjake.fi/gemini/lagrange/raw/branch/release/res/about/help.gmi) | 18 | * And much more! Open `about:help` in the app, or see [help.gmi](https://git.skyjake.fi/gemini/lagrange/raw/branch/release/res/about/help.gmi) |
19 | 19 | ||
20 | ## Downloads | 20 | ## Downloads |
21 | 21 | ||
@@ -35,9 +35,11 @@ sudo zypper install lagrange | |||
35 | 35 | ||
36 | ## How to compile | 36 | ## How to compile |
37 | 37 | ||
38 | This is how to build Lagrange in a POSIX-compatible environment. The required tools are a C11 compiler (e.g., Clang or GCC), CMake and `pkg-config`. | 38 | You need a POSIX-compatible environment to compile Lagrange. |
39 | 39 | ||
40 | 1. Download and extract a source tarball from [Releases][rel]. Please note that the GitHub/Gitea-generated tarballs do not contain the ["the_Foundation" submodule](https://git.skyjake.fi/skyjake/the_Foundation); check which tarball you are getting. Alternatively, you may also clone the repository and its submodules: `git clone --recursive --branch release https://git.skyjake.fi/gemini/lagrange` | 40 | The required tools are a C11 compiler (e.g., Clang or GCC), CMake and `pkg-config`. Additional tools are required for the optional compilation of HarfBuzz and GNU FriBidi (see next section for details). |
41 | |||
42 | 1. Download and extract a source tarball from [Releases][rel]. Please note that the GitHub/Gitea-generated tarballs do not contain HarfBuzz, GNU FriBidi, or [the_Foundation](https://git.skyjake.fi/skyjake/the_Foundation) submodules; check which tarball you are getting. Alternatively, you may also clone the repository and its submodules: `git clone --recursive --branch release https://git.skyjake.fi/gemini/lagrange` | ||
41 | 2. Check that you have the required dependencies installed: CMake, SDL 2, OpenSSL 1.1.1, libpcre, zlib, libunistring. For example, on macOS this would do the trick (using Homebrew): ```brew install cmake sdl2 openssl@1.1 pcre libunistring``` Or on Ubuntu: ```sudo apt install cmake libsdl2-dev libssl-dev libpcre3-dev zlib1g-dev libunistring-dev``` | 43 | 2. Check that you have the required dependencies installed: CMake, SDL 2, OpenSSL 1.1.1, libpcre, zlib, libunistring. For example, on macOS this would do the trick (using Homebrew): ```brew install cmake sdl2 openssl@1.1 pcre libunistring``` Or on Ubuntu: ```sudo apt install cmake libsdl2-dev libssl-dev libpcre3-dev zlib1g-dev libunistring-dev``` |
42 | 3. Optionally, install the mpg123 decoder library for MPEG audio support. For example, the macOS Homebrew package is `mpg123` and on Ubuntu it is `libmpg123-dev`. | 44 | 3. Optionally, install the mpg123 decoder library for MPEG audio support. For example, the macOS Homebrew package is `mpg123` and on Ubuntu it is `libmpg123-dev`. |
43 | 4. Create a build directory. | 45 | 4. Create a build directory. |
@@ -47,16 +49,27 @@ This is how to build Lagrange in a POSIX-compatible environment. The required to | |||
47 | 49 | ||
48 | ### Unicode text rendering | 50 | ### Unicode text rendering |
49 | 51 | ||
50 | (details about HarfBuzz and FriBidi) | 52 | Lagrange relies on the [HarfBuzz](https://harfbuzz.github.io) and [GNU FriBidi](https://github.com/fribidi/fribidi/) libraries for handling complex scripts and bidirectional text. This repository includes these two libraries as submodules. By default, HarfBuzz and GNU FriBidi will be compiled as part of the app, without any additional dependencies. This allows the app to be built on systems where these libraries are not readily available. |
53 | |||
54 | Note that compiling these libraries has the following requirements: | ||
55 | |||
56 | * HarfBuzz requires a C++ compiler. | ||
57 | * GNU FriBidi cannot be compiled with CMake; you need to have [Meson](https://mesonbuild.com) and [Ninja](https://ninja-build.org). | ||
58 | |||
59 | If these requirements cannot be met, or you would prefer the use the system-provided HarfBuzz and GNU FriBidi, the build options can be changed. See the table below for `ENABLE_HARFBUZZ_MINIMAL` and `ENABLE_FRIBIDI_BUILD` (set both to **NO**). Note that a system-provided HarfBuzz likely has dependencies to other libraries, such as FreeType and GLib. | ||
60 | |||
61 | You also may disable HarfBuzz and/or GNU FriBidi entirely. The old text renderer that supports only non-complex left-to-right scripts is then used. | ||
62 | |||
63 | ### Installing to a custom directory | ||
51 | 64 | ||
52 | ### Installing to a directory | 65 | By default, the compiled app will be installed to a system-wide location determined by CMake. |
53 | 66 | ||
54 | Set `CMAKE_INSTALL_PREFIX` to install to a directory of your choosing. | 67 | Set `CMAKE_INSTALL_PREFIX` to install to a directory of your choosing: |
55 | 68 | ||
56 | 1. `cmake {path_of_lagrange_sources} -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=/dest/path` | 69 | 1. `cmake {path_of_lagrange_sources} -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=/dest/path` |
57 | 2. `cmake --build . --target install` | 70 | 2. `cmake --build . --target install` |
58 | 71 | ||
59 | This will also install an XDG .desktop file for launching the app. | 72 | Note that the `install` target also deploys an XDG .desktop file for launching the app. |
60 | 73 | ||
61 | ### Build options | 74 | ### Build options |
62 | 75 | ||
@@ -68,9 +81,9 @@ This will also install an XDG .desktop file for launching the app. | |||
68 | | `ENABLE_IDLE_SLEEP` | Sleep in the main thread instead of waiting for events. On some platforms, `SDL_WaitEvent()` may have a relatively high CPU usage. Setting this to **ON** polls for events periodically but otherwise keeps the main thread sleeping, reducing CPU usage. The drawback is that there is a slightly increased latency reacting to new events after idle mode ends. | | 81 | | `ENABLE_IDLE_SLEEP` | Sleep in the main thread instead of waiting for events. On some platforms, `SDL_WaitEvent()` may have a relatively high CPU usage. Setting this to **ON** polls for events periodically but otherwise keeps the main thread sleeping, reducing CPU usage. The drawback is that there is a slightly increased latency reacting to new events after idle mode ends. | |
69 | | `ENABLE_FRIBIDI` | Use the GNU FriBidi library for processing bidirectional text. FriBidi implements the Unicode Bidirectional Algorithm to determine text directions. | | 82 | | `ENABLE_FRIBIDI` | Use the GNU FriBidi library for processing bidirectional text. FriBidi implements the Unicode Bidirectional Algorithm to determine text directions. | |
70 | | `ENABLE_FRIBIDI_BUILD` | Compile the GNU FriBidi library as part of the build. If set to **OFF**, `pkg-config` is used instead to locate the library. | | 83 | | `ENABLE_FRIBIDI_BUILD` | Compile the GNU FriBidi library as part of the build. If set to **OFF**, `pkg-config` is used instead to locate the library. | |
71 | | `ENABLE_HARFBUZZ` | Use the HarfBuzz library for shaping Unicode text. This is required for correctly rendering complex scripts and composite glyphs. If disabled, a simplified text shaping algorithm is used that only works for non-complex languages like English. | | 84 | | `ENABLE_HARFBUZZ` | Use the HarfBuzz library for shaping Unicode text. This is required for correctly rendering complex scripts and combining glyphs. If disabled, a simplified text shaping algorithm is used that only works for non-complex languages like English. | |
72 | | `ENABLE_HARFBUZZ_MINIMAL` | Build the HarfBuzz library with all dependencies disabled. Useful when building the application for distribution so that the number of deployed dependencies will be minimized. A system-provided version of HarfBuzz is likely built with dependencies on FreeType and ICU at least. If set to **OFF**, `pkg-config` will be used to find HarfBuzz. | | 85 | | `ENABLE_HARFBUZZ_MINIMAL` | Build the HarfBuzz library with all dependencies disabled. Useful when building the app for distribution so that the number of deployed dependencies will be minimized. A system-provided version of HarfBuzz is likely built with dependencies on FreeType and ICU at least. If set to **OFF**, `pkg-config` will be used to find HarfBuzz. | |
73 | | `ENABLE_IPC` | Instances of the Lagrange executable communicate via signals or (on Windows) a system-provided IPC mechanism. This is used for controlling an existing Lagrange window via the CLI. If set to **OFF**, each instance of the application runs without knowledge of other instances. This may cause them to overwrite each other's runtime files. | | 86 | | `ENABLE_IPC` | Instances of the Lagrange executable communicate via signals or (on Windows) a system-provided IPC mechanism. This is used for controlling an existing Lagrange window via the CLI. If set to **OFF**, each instance of the app runs without knowledge of other instances. This may cause them to overwrite each other's runtime files. | |
74 | | `ENABLE_KERNING` | Use kerning information in the fonts to adjust glyph placement. Setting this **ON** improves text appearance in subtle ways but slows down text rendering. It may be a good idea to set this to **OFF** when running on a slow CPU. This option only affects the simple built-in text renderer, and has no effect on HarfBuzz. | | 87 | | `ENABLE_KERNING` | Use kerning information in the fonts to adjust glyph placement. Setting this **ON** improves text appearance in subtle ways but slows down text rendering. It may be a good idea to set this to **OFF** when running on a slow CPU. This option only affects the simple built-in text renderer, and has no effect on HarfBuzz. | |
75 | | `ENABLE_MPG123` | Use the mpg123 library for decoding MPEG audio files. | | 88 | | `ENABLE_MPG123` | Use the mpg123 library for decoding MPEG audio files. | |
76 | | `ENABLE_RELATIVE_EMBED` | Locate resources only in relation to the executable. Useful when any system/predefined directories are not supposed to be accessed, e.g., in the Windows portable build. | | 89 | | `ENABLE_RELATIVE_EMBED` | Locate resources only in relation to the executable. Useful when any system/predefined directories are not supposed to be accessed, e.g., in the Windows portable build. | |
@@ -137,4 +150,4 @@ On Linux/*BSD/other operating systems, user files stored in `~/.config/lagrange` | |||
137 | 150 | ||
138 | The usage and contents of the user files are described in the Help document. You can delete one or more of the files while Lagrange is not running to reset the corresponding data to the default/empty state. | 151 | The usage and contents of the user files are described in the Help document. You can delete one or more of the files while Lagrange is not running to reset the corresponding data to the default/empty state. |
139 | 152 | ||
140 | One instance of Lagrange can be running at a time per user file directory. | 153 | One instance of Lagrange can be running at a time per user directory. |
diff --git a/res/about/help.gmi b/res/about/help.gmi index 9ebf79ba..ebae8846 100644 --- a/res/about/help.gmi +++ b/res/about/help.gmi | |||
@@ -25,8 +25,8 @@ Like Gemini, Lagrange has been designed with minimalism in mind. It depends on a | |||
25 | 25 | ||
26 | ### Features | 26 | ### Features |
27 | 27 | ||
28 | * Beautiful typography using Unicode fonts | 28 | * Beautiful typography with full Unicode support |
29 | * Autogenerated page style and Unicode icon for each Gemini domain | 29 | * Autogenerated page style and symbol for each Gemini domain |
30 | * Light and dark color themes | 30 | * Light and dark color themes |
31 | * Smooth scrolling | 31 | * Smooth scrolling |
32 | * Scaling page content (50%...200%) | 32 | * Scaling page content (50%...200%) |
@@ -36,6 +36,7 @@ Like Gemini, Lagrange has been designed with minimalism in mind. It depends on a | |||
36 | * Split view for browsing two pages at once | 36 | * Split view for browsing two pages at once |
37 | * Persistent app state — tabs and history are restored on next run | 37 | * Persistent app state — tabs and history are restored on next run |
38 | * Configurable keybindings | 38 | * Configurable keybindings |
39 | * Customizable UI color palette | ||
39 | * Open links via keyboard shortcuts | 40 | * Open links via keyboard shortcuts |
40 | * Select and copy text with the mouse | 41 | * Select and copy text with the mouse |
41 | * Find text on the page | 42 | * Find text on the page |
diff --git a/res/about/version.gmi b/res/about/version.gmi index b213a24b..04ad0b99 100644 --- a/res/about/version.gmi +++ b/res/about/version.gmi | |||
@@ -6,6 +6,33 @@ | |||
6 | ``` | 6 | ``` |
7 | # Release notes | 7 | # Release notes |
8 | 8 | ||
9 | ## 1.6 | ||
10 | * Added support for bidirectional text and complex scripts such as Arabic. العالم متنوع | ||
11 | * Added setting for adjusting line spacing. | ||
12 | * Added settings for keyboard and mouse scrolling speeds. | ||
13 | * Added configuration file for defining UI color palette (see Help page). | ||
14 | * Added link context menu item for deleting local files (e.g., Downloads). | ||
15 | * Inline images/audio will not get discarded during back/forward navigation. The Network > Memory Size setting determines the maximum memory usage for media. Setting the Memory Size to zero is equivalent to the previous behavior of discarding everything when the page changes. | ||
16 | * Page contents are cached in presentation form for quicker restoring during back/forward navigation. | ||
17 | * Debug information includes RAM use in addition to cache size. This includes document layout and media stored in memory (e.g., raw pixel data of images). | ||
18 | * Right-to-left paragraphs are aligned to the right. | ||
19 | * Preferences have been reorganized. There is a new Fonts page, and some General settings have been moved to the Style page. All color-related settings are on the Colors page, including UI theme colors. | ||
20 | * Opened links are updated to reflect visited status even when opened in background or to the side. | ||
21 | * Large lede paragraph font is not applied if the paragraph has too many lines. | ||
22 | * Input dialog is not accidentally dismissed unless the Cancel button is clicked or Escape is pressed. | ||
23 | * Unicode Byte Order Mark is ignored in the beginning of a `text/gemini` page. | ||
24 | * Improved internal handling of URLs. For example, some URLs were not being recognized as visited because of percent-encoding differences. | ||
25 | * Fixed URL in the generated page for viewing a single image (spaces weren't encoded). | ||
26 | * Fixed sizing of characters in the Noto Symbols fonts. | ||
27 | * Adjusted kerning of Nunito. | ||
28 | * Updated Smol Emoji with new characters. | ||
29 | * Query/Feeds indicators have a smaller appearance in a narrow window to leave room for the URL. | ||
30 | * Workaround for a potential hang during the closing of a socket. | ||
31 | * Gopher: Improved detection of ASCII art. | ||
32 | * Gopher: All preformatted blocks are unindented. | ||
33 | * Gopher: Don't collapse preformatted blocks since everything is preformatted in the source. | ||
34 | * macOS: ^⌘Space shows the system-provided symbols and Emoji character palette. | ||
35 | |||
9 | ## 1.5.2 | 36 | ## 1.5.2 |
10 | * Fixed pasting a PEM-formatted certificate and/or private key via clipboard in Import Identity. | 37 | * Fixed pasting a PEM-formatted certificate and/or private key via clipboard in Import Identity. |
11 | * Possible workaround for a visual glitch in the URL field. | 38 | * Possible workaround for a visual glitch in the URL field. |