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