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