luxferre/BFG
1
0
Fork 0
Code Actions Activity

more readme fixes, added UNLICENSE

Browse Source
This commit is contained in:
Luxferre
2024-10-06 19:27:12 +03:00
parent 48b5451c91
commit 36f77e4295
2 changed files with 41 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+17 -20
View File
@@ -21,13 +21,13 @@ The following features are already (fully or partially) supported in BFG.
### Complete ### Complete
* Finger protocol (finger:// URLs) * Finger protocol (`finger://` URLs)
* Gopher protocol with optional TLS support (gopher:// and gophers:// URLs) * Gopher protocol with optional TLS support (`gopher://` and `gophers://` URLs)
* Gophermap rendering (entry types 0, 1, 3, 5, 7, 8, 9, i, h) * Gophermap rendering (entry types 0, 1, 3, 5, 7, 8, 9, i, h)
* Single-line search query support for Gopher type 7 resources * Single-line search query support for Gopher type 7 resources
* Nex protocol (nex:// URLs) * Nex protocol (`nex://` URLs)
* Spartan protocol (spartan:// URLs) with single-line text query support * Spartan protocol (`spartan://` URLs) with single-line text query support
* Gemini protocol (gemini:// URLs) with single-line custom input support * Gemini protocol (`gemini://` URLs) with single-line custom input support
* UTF-8 support for text content * UTF-8 support for text content
* Basic history support (back/forward actions) * Basic history support (back/forward actions)
* Page refresh action * Page refresh action
@@ -75,7 +75,7 @@ In general, there are two reasons why a feature might not be implemented in BFG:
## Usage ## Usage
You can run the script with an optional URL to open, e.g.: wish bfg.tcl gopher://hoi.st You can run the script with an optional URL to open, e.g.: `wish bfg.tcl gopher://hoi.st`
The following keybindings are currently supported: The following keybindings are currently supported:
@@ -114,13 +114,13 @@ The following mouse bindings are currently supported:
BFG ships with a bfg.ini file that holds your configuration values and bookmarks. BFG ships with a bfg.ini file that holds your configuration values and bookmarks.
The main configuration sections are: The main configuration sections are:
* [net]: network-related configs, currently only has "timeout" parameter * `[net]`: network-related configs, currently only has "timeout" parameter
* [widget]: general UI widget appearance (ttkTheme, font (button font), entryfont, statusfont) * `[widget]`: general UI widget appearance (ttkTheme, font (button font), entryfont, statusfont)
* [style.general]: general content area appearance (textfont, foreground color, background color) * `[style.general]`: general content area appearance (textfont, foreground color, background color)
* [style.link.normal]: normal link colors (foreground, background) * `[style.link.normal]`: normal link colors (foreground, background)
* [style.link.focused]: currently focused link colors (foreground, background) * `[style.link.focused]`: currently focused link colors (foreground, background)
* [style.highlight]: highlighted area colors (foreground, background) - used with search functionality * `[style.highlight]`: highlighted area colors (foreground, background) - used with search functionality
* [style.error]: error message colors (foreground, background) * `[style.error]`: error message colors (foreground, background)
Feel free to modify the bfg.ini file according to your own preferences, the one shipped is just an example. Feel free to modify the bfg.ini file according to your own preferences, the one shipped is just an example.
@@ -160,9 +160,9 @@ Make sure you're building the target tclkit with Metakit, Tcllib, Tk and TLS pac
Optionally you can select "TLS: Statically link to LibSSL" and/or "TLS: Build LibreSSL for this platform". Optionally you can select "TLS: Statically link to LibSSL" and/or "TLS: Build LibreSSL for this platform".
If the host and target platform are the same, you still need two kit binaries (just make a copy). If the host and target platform are the same, you still need two kit binaries (just make a copy).
2. Download sdx.kit from somewhere, e.g. from [here](https://codeberg.org/luxferre/StreamGoose/raw/branch/main/tcldep/sdx.kit) 2. Download `sdx.kit` from somewhere, e.g. from [here](https://codeberg.org/luxferre/StreamGoose/raw/branch/main/tcldep/sdx.kit)
3. Put the two binaries and sdx.kit into the same directory as bfg.tcl, then run from this directory: 3. Put the two binaries and `sdx.kit` into the same directory as `bfg.tcl`, then run from this directory:
``` ```
[/path/to/host/tclkit] sdx.kit qwrap bfg.tcl -runtime [/path/to/target/tclkit] [/path/to/host/tclkit] sdx.kit qwrap bfg.tcl -runtime [/path/to/target/tclkit]
``` ```
@@ -178,12 +178,9 @@ Alternatively, you can do a proposal in the "Issues" section or even create a pa
However, one of the BFG's goals is to stay under 1000 SLOC no matter what. However, one of the BFG's goals is to stay under 1000 SLOC no matter what.
If you want feature creep, feel free to switch to more suitable clients like Lagrange. If you want feature creep, feel free to switch to more suitable clients like Lagrange.
### Why does a Gopher-over-TLS (gophers:// URL) resource still show plain gopher:// links? ### Why does a Gopher-over-TLS (`gophers://` URL) resource still show plain `gopher://` links?
Due to a limitation of the Gopher-over-TLS protocol itself, we cannot determine if the Gophermap entry points Due to a limitation of the Gopher-over-TLS protocol itself, we cannot determine if the Gophermap entry points to a plain Gopher or a Gopher-over-TLS resource. Hence, only the links belonging to the same host/port pair that was already opened with a `gophers://` link are displayed as `gophers://` links. Everything else needs to be adjusted manually for now. Sorry for the inconvenience.
to a plain Gopher or a Gopher-over-TLS resource. Hence, only the links belonging to the same host/port pair
that was already opened with a gophers:// link are displayed as gophers:// links. Everything else needs to be
adjusted manually for now. Sorry for the inconvenience.
## Credits ## Credits
UNLICENSE
+24
View File
@@ -0,0 +1,24 @@
This is free and unencumbered software released into the public domain.
Anyone is free to copy, modify, publish, use, compile, sell, or
distribute this software, either in source code form or as a compiled
binary, for any purpose, commercial or non-commercial, and by any
means.
In jurisdictions that recognize copyright laws, the author or authors
of this software dedicate any and all copyright interest in the
software to the public domain. We make this dedication for the benefit
of the public at large and to the detriment of our heirs and
successors. We intend this dedication to be an overt act of
relinquishment in perpetuity of all present and future rights to this
software under copyright law.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.
For more information, please refer to <http://unlicense.org/>