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 etc...
17 
18 There are still various things missing or, if you prefer, various
19 things that you can help develop :)
20 
21  - UTF8 handling: it needs to handle non-ASCII characters in pages and
22    in the minibuffer input
23  - bookmarks
24  - subscriptions
25  - tofu
26  - client certificates
27  - add other GUI: atm it uses 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 ![Telescope new tab](images/about-new.png)
34 
35 
36 ## Building
37 
38 Telescope depends on ncursesw, libtls (from either LibreSSL or
39 libretls), libevent (either v1 or v2).
40 
41 To build a release tarball just execute:
42 
43 	./configure
44 	make
45 	sudo make install
46 
47 If you want to build from the git checkout, something that's
48 discouraged for users who don't intend to hack on telescope
49 
50 	./autogen.sh
51 	./configure
52 	make
53 	sudo make install	# eventually
54 
55 Please keep in mind that the main branch, from time to time, may be
56 accidentally broken on some platforms.  Telescope is developed
57 primarily on OpenBSD/amd64 and commits on the main branch don't get
58 always tested in other OSes.  Before tagging a release however, a
59 comprehensive testing on various platform is done to ensure everything
60 is working as intended.
61 
62 
63 ## License
64 
65 Telescope is distributed under a BSD-style licence.  The main code is
66 under the ISC but some files under `compat/` are BSD2 or BSD3.