From 48b5451c91dc00189aaf7cd94ecd3cc949e2f393 Mon Sep 17 00:00:00 2001 From: Luxferre Date: Sun, 6 Oct 2024 19:23:00 +0300 Subject: [PATCH] updated readme to the MD format for Codeberg (to codeberg: pls introduce .gmi rendering as well) --- README.gmi => README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) rename README.gmi => README.md (96%) diff --git a/README.gmi b/README.md similarity index 96% rename from README.gmi rename to README.md index 23424bc..7627921 100644 --- a/README.gmi +++ b/README.md @@ -1,11 +1,13 @@ # BFG: a multiprotocol "small web" browser in Tcl/Tk BFG (stands for Back/Forward/Go) is a: + * free (absolutely), * open-source, * cross-platform, * single-script, * self-contained + GUI client for a number of "small web" protocols like Gopher, Finger, Nex, Spartan and Gemini. BFG is written in under 1000 SLOC of Tcl 8.6 and depends upon Tcllib, Tk (obviously) and TclTLS. @@ -153,22 +155,20 @@ In fact, the browser name itself contains the first three keybindings to start u The main idea of BFG is to be as portable as possible, so no, binaries will not be distributed here. However, you always can do it yourself. Here's how. -1. Obtain the tclkits for your host and target platforms, e.g. build them here: -=> https://kitcreator.rkeene.org/kitcreator +1. Obtain the tclkits for your host and target platforms, e.g. build them [here](https://kitcreator.rkeene.org/kitcreator). Make sure you're building the target tclkit with Metakit, Tcllib, Tk and TLS packages enabled. 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). -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: ``` [/path/to/host/tclkit] sdx.kit qwrap bfg.tcl -runtime [/path/to/target/tclkit] ``` -A file just named "bfg" should appear, this is your executable. +A file just named `bfg` should appear, this is your executable. -4. If building for Windows, rename "bfg" to "bfg.exe". +4. If building for Windows, rename `bfg` to `bfg.exe`. ### I want this feature X to be implemented! Can you do this?