5 4def0885 2021-03-12 op |_ _|.-----.| |.-----.-----.----.-----.-----.-----.
6 4def0885 2021-03-12 op | | | -__|| || -__|__ --| __| _ | _ | -__|
7 4def0885 2021-03-12 op |___| |_____||__||_____|_____|____|_____| __|_____|
11 cd302034 2021-03-15 op Telescope is a w3m-like browser for Gemini.
13 cd302034 2021-03-15 op At the moment, it's something **a bit more than a working demo**.
14 cd302034 2021-03-15 op However, it has already some interesting features, like streaming
15 cd302034 2021-03-15 op pages, tabs, privsep, input from the minibuffer etc...
17 4def0885 2021-03-12 op There are still various things missing or, if you prefer, various
18 4def0885 2021-03-12 op things that you can help develop :)
20 4def0885 2021-03-12 op - subscriptions
21 3be78a24 2021-03-17 op - tofu oob verification
22 4def0885 2021-03-12 op - client certificates
23 0f7e6318 2021-06-20 op - add other GUIs: at the moment it uses only ncurses, but telescope
24 0f7e6318 2021-06-20 op shouldn't be restricted to TTYs only!
26 fe5636b8 2021-07-17 op [](https://asciinema.org/a/425971)
29 cd302034 2021-03-15 op ## Why yet another browser?
31 cd302034 2021-03-15 op One of the great virtues of Gemini is its simplicity. It means that
32 cd302034 2021-03-15 op writing browsers or server is easy and thus a plethora of those
33 cd302034 2021-03-15 op exists. I myself routinely switch between a couple of them, depending
36 cd302034 2021-03-15 op More browsers brings more stability as it became more difficult to
37 cd302034 2021-03-15 op change the protocol, too.
39 cd302034 2021-03-15 op However, Telescope was ultimately written for fun, on a whim, just to
40 cd302034 2021-03-15 op play with ncurses, libtls, libevent and the macros from `sys/queue.h`,
41 cd302034 2021-03-15 op but I'd like to finish it into a complete Gemini browser.
46 cd302034 2021-03-15 op - Fun: hacking on Telescope should be fun.
47 cd302034 2021-03-15 op - Clean: write readable and clean code mostly following the style(9)
48 cd302034 2021-03-15 op guideline. Don't become a kitchen sink.
49 cd302034 2021-03-15 op - Secure: write secure code with privilege separation to mitigate the
50 cd302034 2021-03-15 op security risks of possible bugs.
51 cd302034 2021-03-15 op - Fast: it features a modern, fast, event-based asynchronous I/O
53 656b4b64 2021-03-16 op - Cooperation: re-use existing conventions to allow inter-operations
54 656b4b64 2021-03-16 op and easy migrations from/to other clients.
59 3be78a24 2021-03-17 op Telescope aims to use the "Trust, but Verify (where appropriate)"
60 3be78a24 2021-03-17 op approach outlined here:
61 3be78a24 2021-03-17 op [gemini://thfr.info/gemini/modified-trust-verify.gmi](gemini://thfr.info/gemini/modified-trust-verify.gmi).
63 3be78a24 2021-03-17 op The idea is to define three level of verification for a certificate:
65 3be78a24 2021-03-17 op - **untrusted**: the server fingerprint does NOT match the stored
67 3be78a24 2021-03-17 op - **trusted**: the server fingerprint matches the stored one
68 3be78a24 2021-03-17 op - **verified**: the fingerprint matches and has been verified
69 3be78a24 2021-03-17 op out-of-band by the client.
71 3be78a24 2021-03-17 op Most of the time, the `trusted` level is enough, but where is
72 3be78a24 2021-03-17 op appropriate users should be able to verify out-of-band the
75 018a3114 2021-07-03 op At the moment there is no UI for oob-verification though.
80 4def0885 2021-03-12 op Telescope depends on ncursesw, libtls (from either LibreSSL or
81 741428e3 2021-06-15 op libretls), libevent (either v1 or v2). When building from a git
82 741428e3 2021-06-15 op checkout, yacc (or bison) is also needed.
84 97e30cc6 2021-03-14 op To build from a release tarball just execute:
88 4def0885 2021-03-12 op sudo make install
90 4def0885 2021-03-12 op If you want to build from the git checkout, something that's
91 cd302034 2021-03-15 op discouraged for users that don't intend to hack on telescope
96 4def0885 2021-03-12 op sudo make install # eventually
98 4def0885 2021-03-12 op Please keep in mind that the main branch, from time to time, may be
99 4def0885 2021-03-12 op accidentally broken on some platforms. Telescope is developed
100 4def0885 2021-03-12 op primarily on OpenBSD/amd64 and commits on the main branch don't get
101 4def0885 2021-03-12 op always tested in other OSes. Before tagging a release however, a
102 12a43913 2021-06-26 op comprehensive testing on various platforms is done to ensure everything
103 4def0885 2021-03-12 op is working as intended.
108 c6cad9e5 2021-07-17 op Any form of contribution is appreciated, not only patches or bug
109 1c4989cd 2021-07-17 op reports. The contrib directory is for external things such as sample
110 1c4989cd 2021-07-17 op configuration files, themes, scripts and things like that.
113 afa57f78 2021-07-15 op ## User files
115 afa57f78 2021-07-15 op Telescope stores user files in `~/.telescope`. The usage and contents
116 afa57f78 2021-07-15 op of these files are described in [the man page](telescope.1), under
117 afa57f78 2021-07-15 op "FILES". There's no support yet for XDG-style directories.
119 afa57f78 2021-07-15 op Only one instance of Telescope can be running at time per user.
124 4def0885 2021-03-12 op Telescope is distributed under a BSD-style licence. The main code is
125 4def0885 2021-03-12 op under the ISC but some files under `compat/` are BSD2 or BSD3.
127 bf6551ee 2021-07-18 op `data/emoji.txt` is copyright © 1991-2021 Unicode, Inc. and
128 bf6551ee 2021-07-18 op distributed under the [UNICODE, Inc license agreement][unicode-license].
131 bf6551ee 2021-07-18 op [unicode-license]: https://www.unicode.org/license.html
