1 ```
2  _______         __
3 |_     _|.-----.|  |.-----.-----.----.-----.-----.-----.
4   |   |  |  -__||  ||  -__|__ --|  __|  _  |  _  |  -__|
5   |___|  |_____||__||_____|_____|____|_____|   __|_____|
6                                            |__|
7 ```
8 
9 Telescope is a w3m-like browser for Gemini.
10 
11 At the moment, it's something **a bit more than a working demo**.
12 However, it has already some interesting features, like streaming
13 pages, tabs, privsep, input from the minibuffer etc...
14 
15 There are still various things missing or, if you prefer, various
16 things that you can help develop :)
17 
18  - UTF8 handling: it needs to handle non-ASCII characters in pages and
19    in the minibuffer input
20  - bookmarks
21  - subscriptions
22  - tofu
23  - client certificates
24  - add other GUIs: atm it uses only ncurses, but telescope shouldn't
25    be restricted to TTYs only!
26  - configuration file: even proposals are accepted.  It needs a way to
27    define keybindings, colors etc in a way that will possibly work on
28    more than one graphic libraries.
29 
30 ![Telescope new tab](images/about-new.png)
31 
32 
33 ## Why yet another browser?
34 
35 One of the great virtues of Gemini is its simplicity.  It means that
36 writing browsers or server is easy and thus a plethora of those
37 exists.  I myself routinely switch between a couple of them, depending
38 on my mood.
39 
40 More browsers brings more stability as it became more difficult to
41 change the protocol, too.
42 
43 However, Telescope was ultimately written for fun, on a whim, just to
44 play with ncurses, libtls, libevent and the macros from `sys/queue.h`,
45 but I'd like to finish it into a complete Gemini browser.
46 
47 
48 ## Goals
49 
50  - Fun: hacking on Telescope should be fun.
51  - Clean: write readable and clean code mostly following the style(9)
52    guideline.  Don't become a kitchen sink.
53  - Secure: write secure code with privilege separation to mitigate the
54    security risks of possible bugs.
55  - Fast: it features a modern, fast, event-based asynchronous I/O
56    model, it shouldn't never lags behind the user input.
57  - Inter-operable: re-use existing conventions to allow
58    inter-operations and easy migrations from/to other clients.
59 
60 
61 ## Building
62 
63 Telescope depends on ncursesw, libtls (from either LibreSSL or
64 libretls), libevent (either v1 or v2).
65 
66 To build from a release tarball just execute:
67 
68 	./configure
69 	make
70 	sudo make install
71 
72 If you want to build from the git checkout, something that's
73 discouraged for users that don't intend to hack on telescope
74 
75 	./autogen.sh
76 	./configure
77 	make
78 	sudo make install	# eventually
79 
80 Please keep in mind that the main branch, from time to time, may be
81 accidentally broken on some platforms.  Telescope is developed
82 primarily on OpenBSD/amd64 and commits on the main branch don't get
83 always tested in other OSes.  Before tagging a release however, a
84 comprehensive testing on various platform is done to ensure everything
85 is working as intended.
86 
87 
88 ## License
89 
90 Telescope is distributed under a BSD-style licence.  The main code is
91 under the ISC but some files under `compat/` are BSD2 or BSD3.