1 4def0885 2021-03-12 op ```
 2 4def0885 2021-03-12 op  _______         __
 3 4def0885 2021-03-12 op |_     _|.-----.|  |.-----.-----.----.-----.-----.-----.
 4 4def0885 2021-03-12 op   |   |  |  -__||  ||  -__|__ --|  __|  _  |  _  |  -__|
 5 4def0885 2021-03-12 op   |___|  |_____||__||_____|_____|____|_____|   __|_____|
 6 4def0885 2021-03-12 op                                            |__|
 7 4def0885 2021-03-12 op ```
 8 5e11c00c 2021-03-02 op 
 9 4def0885 2021-03-12 op Telescope is a w3m-like browser for Gemini.  It was written on a whim,
10 4def0885 2021-03-12 op just to play with ncurses, libtls, libevent and the macros from
11 4def0885 2021-03-12 op `sys/queue.h`, but I'd like to finish it into a featureful Gemini
12 4def0885 2021-03-12 op browser.
13 4def0885 2021-03-12 op 
14 4def0885 2021-03-12 op At the moment, telescope is something **a bit more than a working
15 4def0885 2021-03-12 op demo**.  However, it has already some interesting features, like tabs,
16 2058a15d 2021-03-13 op privsep, input from the minibuffer etc...
17 4def0885 2021-03-12 op 
18 4def0885 2021-03-12 op There are still various things missing or, if you prefer, various
19 4def0885 2021-03-12 op things that you can help develop :)
20 4def0885 2021-03-12 op 
21 2058a15d 2021-03-13 op  - UTF8 handling: it needs to handle non-ASCII characters in pages and
22 4def0885 2021-03-12 op    in the minibuffer input
23 4def0885 2021-03-12 op  - bookmarks
24 4def0885 2021-03-12 op  - subscriptions
25 4def0885 2021-03-12 op  - tofu
26 4def0885 2021-03-12 op  - client certificates
27 2058a15d 2021-03-13 op  - add other GUI: atm it uses only ncurses, but telescope shouldn't be
28 4def0885 2021-03-12 op    restricted to TTYs only!
29 4def0885 2021-03-12 op  - configuration file: even proposals are accepted.  I need a way to
30 4def0885 2021-03-12 op    define bindings, colors etc in a way that will possibly work on
31 4def0885 2021-03-12 op    more than one graphic libraries.
32 4def0885 2021-03-12 op 
33 2058a15d 2021-03-13 op ![Telescope new tab](images/about-new.png)
34 4def0885 2021-03-12 op 
35 2058a15d 2021-03-13 op 
36 4def0885 2021-03-12 op ## Building
37 4def0885 2021-03-12 op 
38 4def0885 2021-03-12 op Telescope depends on ncursesw, libtls (from either LibreSSL or
39 4def0885 2021-03-12 op libretls), libevent (either v1 or v2).
40 4def0885 2021-03-12 op 
41 4def0885 2021-03-12 op To build a release tarball just execute:
42 4def0885 2021-03-12 op 
43 4def0885 2021-03-12 op 	./configure
44 4def0885 2021-03-12 op 	make
45 4def0885 2021-03-12 op 	sudo make install
46 4def0885 2021-03-12 op 
47 4def0885 2021-03-12 op If you want to build from the git checkout, something that's
48 4def0885 2021-03-12 op discouraged for users who don't intend to hack on telescope
49 4def0885 2021-03-12 op 
50 4def0885 2021-03-12 op 	./autogen.sh
51 4def0885 2021-03-12 op 	./configure
52 4def0885 2021-03-12 op 	make
53 4def0885 2021-03-12 op 	sudo make install	# eventually
54 4def0885 2021-03-12 op 
55 4def0885 2021-03-12 op Please keep in mind that the main branch, from time to time, may be
56 4def0885 2021-03-12 op accidentally broken on some platforms.  Telescope is developed
57 4def0885 2021-03-12 op primarily on OpenBSD/amd64 and commits on the main branch don't get
58 4def0885 2021-03-12 op always tested in other OSes.  Before tagging a release however, a
59 4def0885 2021-03-12 op comprehensive testing on various platform is done to ensure everything
60 4def0885 2021-03-12 op is working as intended.
61 4def0885 2021-03-12 op 
62 4def0885 2021-03-12 op 
63 4def0885 2021-03-12 op ## License
64 4def0885 2021-03-12 op 
65 4def0885 2021-03-12 op Telescope is distributed under a BSD-style licence.  The main code is
66 4def0885 2021-03-12 op under the ISC but some files under `compat/` are BSD2 or BSD3.