diff options
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 34 |
1 files changed, 30 insertions, 4 deletions
@@ -1,4 +1,4 @@ | |||
1 | # Lagrange — A Beautiful Gemini Client | 1 | # Lagrange |
2 | 2 | ||
3 | Lagrange is a desktop GUI client for browsing Geminispace. It offers modern conveniences familiar from web browsers, such as smooth scrolling, inline image viewing, multiple tabs, visual themes, Unicode fonts, bookmarks, history, and page outlines. | 3 | Lagrange is a desktop GUI client for browsing Geminispace. It offers modern conveniences familiar from web browsers, such as smooth scrolling, inline image viewing, multiple tabs, visual themes, Unicode fonts, bookmarks, history, and page outlines. |
4 | 4 | ||
@@ -8,11 +8,37 @@ Like Gemini, Lagrange has been designed with minimalism in mind. It depends on a | |||
8 | 8 | ||
9 | ## Features | 9 | ## Features |
10 | 10 | ||
11 | 11 | * Beautiful typography using Unicode fonts | |
12 | * Autogenerated page style and Unicode icon for each Gemini domain | ||
13 | * Smart suggestions when typing the URL — search bookmarks, history, identities | ||
14 | * Sidebar for page outline, managing bookmarks and identities, and viewing history | ||
15 | * Multiple tabs | ||
16 | * Identity management — create and use TLS client certificates | ||
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) | ||
12 | 18 | ||
13 | ## Downloads | 19 | ## Downloads |
14 | 20 | ||
15 | Binaries for Windows and macOS and a source tarball can be found in [Releases](https://git.skyjake.fi/skyjake/lagrange/releases). | 21 | Prebuilt binaries for Windows and macOS can be found in [Releases][rel]. |
22 | |||
23 | ## How to compile | ||
24 | |||
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 | |||
27 | 1. Download and extract a source tarball from [Releases][rel]. (If you just clone this Git repository, [the_Foundation][tf] is expected to be already available on the system.) | ||
28 | 2. Check that you have the dependencies installed: SDL2, OpenSSL, libpcre, zlib, libunistring. For example, on Homebrew this would do the trick: ```brew install sdl2 openssl@1.1 pcre libunistring``` Or on Ubuntu: ```sudo apt install libsdl2-dev libssl-dev libpcre3-dev zlib1g-dev libunistring-dev``` | ||
29 | 3. Create a build directory. | ||
30 | 4. In your empty build directory, run CMake: ```cmake {path_of_lagrange_sources}``` | ||
31 | 5. Built it: ```cmake --build .``` | ||
32 | 6. Now you can run `lagrange`, `lagrange.exe`, or `Lagrange.app`. | ||
33 | |||
34 | ## Installing to a directory | ||
35 | |||
36 | To install to "/dest/path": | ||
37 | |||
38 | 1. `cmake {path_of_lagrange_sources} -DCMAKE_INSTALL_PREFIX=/dest/path` | ||
39 | 2. `cmake --build . --target install` | ||
16 | 40 | ||
17 | ## Build instructions | 41 | This will also install an XDG .desktop file for launching the app. |
18 | 42 | ||
43 | [rel]: https://git.skyjake.fi/skyjake/lagrange/releases | ||
44 | [tf]: https://git.skyjake.fi/skyjake/the_Foundation | ||