diff options
author | Jaakko Keränen <jaakko.keranen@iki.fi> | 2020-10-16 19:04:34 +0300 |
---|---|---|
committer | Jaakko Keränen <jaakko.keranen@iki.fi> | 2020-10-16 19:04:34 +0300 |
commit | 92c6007fe54410dfe097ff493fdc86ad2847857a (patch) | |
tree | 50fd32ab5d85c4c691041e5329374cf0e58fd0c7 | |
parent | 3d723de1022d2fdeccb9bae6f934e6936445ef21 (diff) |
Updated README
Added mention of optional mpg123 decoder library.
-rw-r--r-- | README.md | 12 | ||||
-rw-r--r-- | res/about/help.gmi | 3 | ||||
-rw-r--r-- | res/about/license.gmi | 2 |
3 files changed, 10 insertions, 7 deletions
@@ -14,6 +14,7 @@ Like Gemini, Lagrange has been designed with minimalism in mind. It depends on a | |||
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 | * And more! Open `about:help` in the app, or see [help.gmi](https://git.skyjake.fi/skyjake/lagrange/raw/branch/release/res/about/help.gmi) | 18 | * And more! Open `about:help` in the app, or see [help.gmi](https://git.skyjake.fi/skyjake/lagrange/raw/branch/release/res/about/help.gmi) |
18 | 19 | ||
19 | ## Downloads | 20 | ## Downloads |
@@ -25,11 +26,12 @@ Prebuilt binaries for Windows and macOS can be found in [Releases][rel]. | |||
25 | This is how to build Lagrange in a Unix-like environment. The required tools are a C11 compiler (e.g., Clang or GCC), CMake and `pkg-config`. | 26 | This is how to build Lagrange in a Unix-like environment. The required tools are a C11 compiler (e.g., Clang or GCC), CMake and `pkg-config`. |
26 | 27 | ||
27 | 1. Download and extract a source tarball from [Releases][rel]. Alternatively, you may also clone the repository and its submodules: `git clone --recursive --branch release https://git.skyjake.fi/skyjake/lagrange` | 28 | 1. Download and extract a source tarball from [Releases][rel]. Alternatively, you may also clone the repository and its submodules: `git clone --recursive --branch release https://git.skyjake.fi/skyjake/lagrange` |
28 | 2. Check that you have the 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``` | 29 | 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``` |
29 | 3. Create a build directory. | 30 | 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`. |
30 | 4. In your empty build directory, run CMake: ```cmake {path_of_lagrange_sources} -DCMAKE_BUILD_TYPE=Release``` | 31 | 4. Create a build directory. |
31 | 5. Build it: ```cmake --build .``` | 32 | 5. In your empty build directory, run CMake: ```cmake {path_of_lagrange_sources} -DCMAKE_BUILD_TYPE=Release``` |
32 | 6. Now you can run `lagrange`, `lagrange.exe`, or `Lagrange.app`. | 33 | 6. Build it: ```cmake --build .``` |
34 | 7. Now you can run `lagrange`, `lagrange.exe`, or `Lagrange.app`. | ||
33 | 35 | ||
34 | ### Installing to a directory | 36 | ### Installing to a directory |
35 | 37 | ||
diff --git a/res/about/help.gmi b/res/about/help.gmi index 668f0381..80eb62ab 100644 --- a/res/about/help.gmi +++ b/res/about/help.gmi | |||
@@ -28,6 +28,7 @@ Like Gemini, Lagrange has been designed with minimalism in mind. It depends on a | |||
28 | * Select and copy text with the mouse | 28 | * Select and copy text with the mouse |
29 | * Find text on the page | 29 | * Find text on the page |
30 | * Open image links inline on the same page | 30 | * Open image links inline on the same page |
31 | * Audio playback: MP3, Ogg Vorbis, WAV | ||
31 | * Open links via keyboard shortcuts | 32 | * Open links via keyboard shortcuts |
32 | * Instant back/forward navigation | 33 | * Instant back/forward navigation |
33 | * Smooth scrolling | 34 | * Smooth scrolling |
@@ -118,7 +119,7 @@ The sidebar can be toggled via menus or by pressing ${SHIFT+}${CTRL+}L. It has f | |||
118 | * Bookmarks: List of bookmarks that you've created. These appear first in search results for quick and easy access. | 119 | * Bookmarks: List of bookmarks that you've created. These appear first in search results for quick and easy access. |
119 | * History: Chronological list of visited URLs. This is not a full history of all the URLs you've accessed over time — only unique URLs are shown at the latest access time. | 120 | * History: Chronological list of visited URLs. This is not a full history of all the URLs you've accessed over time — only unique URLs are shown at the latest access time. |
120 | * Identities: TLS client certificates. | 121 | * Identities: TLS client certificates. |
121 | * Outline: List of the headings in the currently open tab. Useful when reading longer documents. | 122 | * Outline: List of the headings in the currently open tab. Useful when reading longer documents. |
122 | 123 | ||
123 | ${CTRL+}1 through ${CTRL+}4 switch between the sidebar tabs, or hide the sidebar if the current tab's key is pressed. | 124 | ${CTRL+}1 through ${CTRL+}4 switch between the sidebar tabs, or hide the sidebar if the current tab's key is pressed. |
124 | 125 | ||
diff --git a/res/about/license.gmi b/res/about/license.gmi index ac4310c7..ef92d647 100644 --- a/res/about/license.gmi +++ b/res/about/license.gmi | |||
@@ -31,7 +31,7 @@ SDL 2.0 and newer are available under the zlib license: | |||
31 | 31 | ||
32 | ## mpg123 | 32 | ## mpg123 |
33 | 33 | ||
34 | mpg123 is a fast console MPEG audio player and decoder library. It is licensed under LGPL 2.1. | 34 | mpg123 is a fast console MPEG audio player and decoder library. It is licensed under LGPL 2.1. Lagrange uses the libmpg123 decoder library when playing back MPEG audio. |
35 | => https://www.gnu.org/licenses/old-licenses/lgpl-2.1.en.html GNU LGPL version 2.1 | 35 | => https://www.gnu.org/licenses/old-licenses/lgpl-2.1.en.html GNU LGPL version 2.1 |
36 | => https://mpg123.org/ mpg123 | 36 | => https://mpg123.org/ mpg123 |
37 | 37 | ||