diff options
Diffstat (limited to 'res/about/help.gmi')
-rw-r--r-- | res/about/help.gmi | 115 |
1 files changed, 113 insertions, 2 deletions
diff --git a/res/about/help.gmi b/res/about/help.gmi index ad569230..100efc80 100644 --- a/res/about/help.gmi +++ b/res/about/help.gmi | |||
@@ -4,14 +4,34 @@ | |||
4 | |___ /~~\ \__> | \ /~~\ | \| \__> |___ | 4 | |___ /~~\ \__> | \ /~~\ | \| \__> |___ |
5 | 5 | ||
6 | ``` | 6 | ``` |
7 | # Help | 7 | # Introduction |
8 | 8 | ||
9 | ## What is Lagrange | 9 | ## What is Lagrange |
10 | 10 | ||
11 | ## What is the Gemini protocol | 11 | Lagrange is a GUI client for browsing Geminispace. It offers modern conveniences familiar from web browsers, such as smooth scrolling, inline image viewing, multiple tabs, visual themes, Unicode fonts, bookmarks, history, and page outlines. |
12 | |||
13 | Lagrange relies on a minimal set of dependencies. It is written in C and uses SDL for window management and hardware-accelerated graphics. OpenSSL is used for secure communications. | ||
14 | |||
15 | => https://www.libsdl.org SDL: Simple DirectMedia Layer | ||
16 | => https://www.openssl.org OpenSSL: Cryptography and SSL/TLS Toolkit | ||
17 | |||
18 | ## What is Gemini | ||
19 | |||
20 | Gemini is a simple protocol for serving content over the internet. It specifies a Markdown inspired format allowing basic plain text document markup. Compared to HTTP and HTML, Gemini is vastly simpler and easier to work with. | ||
21 | |||
22 | => gemini://gemini.circumlunar.space/docs/faq.gmi Project Gemini FAQ | ||
23 | => gemini://gemini.circumlunar.space/docs/specification.gmi Protocol and text/gemini specification | ||
12 | 24 | ||
13 | ## Why not just use a web browser | 25 | ## Why not just use a web browser |
14 | 26 | ||
27 | Modern web browsers are complex beasts. In fact, they are so complex that one can create a fully functional virtual machine inside one and run another operating system! | ||
28 | |||
29 | => https://win95.ajf.me Windows 95 on DOSBox (using Emscripten) | ||
30 | |||
31 | If one seeks to just read text and view images, this is absurd overkill. While having a universal platform that runs on everything and everywhere is clearly a valuable notion, it comes with a hefty price tag. The software stack towers ever higher, and similarly hardware needs to be ever more powerful and complicated to run it well. But everything happening over the internet doesn't have to be on this behemoth. | ||
32 | |||
33 | One way to browse Gemini content is via web browser extensions or proxies that translate the content for the web. This may be a sufficient and easy solution for you. However, native clients such as Lagrange also benefit from the simpleness of the protocol and the content. The experience can be optimized, and the software runs well even on simple hardware like the Raspberry Pi. | ||
34 | |||
15 | # User interface | 35 | # User interface |
16 | 36 | ||
17 | ## Navigation | 37 | ## Navigation |
@@ -33,3 +53,94 @@ TLS client certificates used to identify you. | |||
33 | # Platform-specific instructions | 53 | # Platform-specific instructions |
34 | 54 | ||
35 | # Compiling from source | 55 | # Compiling from source |
56 | |||
57 | # Open source licenses | ||
58 | |||
59 | Lagrange itself is distributed under the BSD 2-clause license: | ||
60 | => https://opensource.org/licenses/BSD-2-Clause The 2-Clause BSD License | ||
61 | |||
62 | > Copyright 2020 Jaakko Keränen | ||
63 | > | ||
64 | > Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: | ||
65 | > | ||
66 | > 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. | ||
67 | > | ||
68 | > 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. | ||
69 | > | ||
70 | > THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | ||
71 | |||
72 | ## SDL | ||
73 | |||
74 | SDL 2.0 and newer are available under the zlib license: | ||
75 | => https://www.zlib.net/zlib_license.html ZLIB License | ||
76 | |||
77 | > This software is provided 'as-is', without any express or implied warranty. In no event will the authors be held liable for any damages arising from the use of this software. | ||
78 | > | ||
79 | > Permission is granted to anyone to use this software for any purpose, including commercial applications, and to alter it and redistribute it freely, subject to the following restrictions: | ||
80 | > | ||
81 | > 1. The origin of this software must not be misrepresented; you must not claim that you wrote the original software. If you use this software in a product, an acknowledgment in the product documentation would be appreciated but is not required. | ||
82 | > | ||
83 | > 2. Altered source versions must be plainly marked as such, and must not be misrepresented as being the original software. | ||
84 | > | ||
85 | > 3. This notice may not be removed or altered from any source distribution. | ||
86 | |||
87 | ## the_Foundation | ||
88 | |||
89 | the_Foundation is an opinionated C11 library by Jaakko Keränen. It is under the BSD 2-clause license. Note that the rest of the libraries in this section are used by the_Foundation, and not directly by Lagrange. | ||
90 | => https://opensource.org/licenses/BSD-2-Clause The 2-Clause BSD License | ||
91 | => https://git.skyjake.fi/skyjake/the_Foundation.git the_Foundation Git repository | ||
92 | |||
93 | ## OpenSSL | ||
94 | |||
95 | OpenSSL 1.1.1 is under a double license, which both apply to the library. | ||
96 | => https://www.openssl.org/source/license-openssl-ssleay.txt OpenSSL and SSLeay Licenses | ||
97 | |||
98 | > Copyright (c) 1998-2019 The OpenSSL Project. All rights reserved. | ||
99 | > | ||
100 | > Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: | ||
101 | > | ||
102 | > 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. | ||
103 | > | ||
104 | > 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. | ||
105 | > | ||
106 | > 3. All advertising materials mentioning features or use of this software must display the following acknowledgment: "This product includes software developed by the OpenSSL Project for use in the OpenSSL Toolkit. (http://www.openssl.org/)" | ||
107 | > | ||
108 | > 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to endorse or promote products derived from this software without prior written permission. For written permission, please contact openssl-core@openssl.org. | ||
109 | > | ||
110 | > 5. Products derived from this software may not be called "OpenSSL" nor may "OpenSSL" appear in their names without prior written permission of the OpenSSL Project. | ||
111 | > | ||
112 | > 6. Redistributions of any form whatsoever must retain the following acknowledgment: "This product includes software developed by the OpenSSL Project for use in the OpenSSL Toolkit (http://www.openssl.org/)" | ||
113 | > | ||
114 | > THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | ||
115 | > | ||
116 | > This product includes cryptographic software written by Eric Young (eay@cryptsoft.com). This product includes software written by Tim Hudson (tjh@cryptsoft.com). | ||
117 | |||
118 | SSLeay license: | ||
119 | |||
120 | > Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com) | ||
121 | > All rights reserved. | ||
122 | > | ||
123 | > This package is an SSL implementation written by Eric Young (eay@cryptsoft.com). The implementation was written so as to conform with Netscapes SSL. | ||
124 | > | ||
125 | > This library is free for commercial and non-commercial use as long as the following conditions are aheared to. The following conditions apply to all code found in this distribution, be it the RC4, RSA, lhash, DES, etc., code; not just the SSL code. The SSL documentation included with this distribution is covered by the same copyright terms except that the holder is Tim Hudson (tjh@cryptsoft.com). | ||
126 | > | ||
127 | > Copyright remains Eric Young's, and as such any Copyright notices in the code are not to be removed. If this package is used in a product, Eric Young should be given attribution as the author of the parts of the library used. This can be in the form of a textual message at program startup or in documentation (online or textual) provided with the package. | ||
128 | > | ||
129 | > Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: | ||
130 | > | ||
131 | > 1. Redistributions of source code must retain the copyright notice, this list of conditions and the following disclaimer. | ||
132 | > | ||
133 | > 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. | ||
134 | > | ||
135 | > 3. All advertising materials mentioning features or use of this software must display the following acknowledgement: "This product includes cryptographic software written by Eric Young (eay@cryptsoft.com)" The word 'cryptographic' can be left out if the rouines from the library being used are not cryptographic related :-). | ||
136 | > | ||
137 | > 4. If you include any Windows specific code (or a derivative thereof) from the apps directory (application code) you must include an acknowledgement: "This product includes software written by Tim Hudson (tjh@cryptsoft.com)" | ||
138 | > | ||
139 | > THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | ||
140 | > | ||
141 | > The licence and distribution terms for any publically available version or derivative of this code cannot be changed. i.e. this code cannot simply be copied and put under another distribution licence [including the GNU Public Licence.] | ||
142 | |||
143 | ## GNU libunistring | ||
144 | |||
145 | The libunistring library is covered by the GNU Lesser General Public License (LGPL): | ||
146 | => https://www.gnu.org/software/libunistring/manual/libunistring.html#GNU-LGPL GNU LGPL License | ||