mleku/realy-protocol
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

switch all the things to asciidoc

Browse Source
This commit is contained in:
mleku
2025-02-02 18:38:57 -01:06
parent 9914469cc2
commit abf02e9e0d
9 changed files with 28 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
clients/readme.adoc Normal file
View File

@@ -0,0 +1,3 @@
= clients
here be some reference clients for various sub-protocols

3
clients/readme.md
View File

@@ -1,3 +0,0 @@
# clients
here be some reference clients for various sub-protocols

30
pkg/lol/readme.md → pkg/lol/readme.adoc
View File

@@ -1,35 +1,37 @@
# lol
= lol
location of log
This is a very simple, but practical library for logging in applications. Its
main feature is printing source code locations to make debugging easier.
## usage
== usage
put this somewhere in your package:
```go
[source,go]
----
var log, chk, errorf = lol.Main.Log, lol.Main.Check, lol.Main.Errorf
```
----
then you can invoke like this:
```go
[source,go]
----
log.I.S(spew.this.thing)
errorf.E("print and return this error")
if err = bogus; chk.E(err) { return bogus.response } // print an error at the site and return the error
```
----
## terminals
== terminals
Due to how so few terminals actually support source location hyperlinks, pretty much tilix and intellij terminal are
the only two that really provide adequate functionality, this logging library defaults to output format that works
best with intellij. As such, the terminal is aware of the CWD and the code locations printed are relative, as
required to get the hyperlinkization from this terminal. Handling support for Tilix requires more complications and
due to advances with IntelliJ's handling it is not practical to support any other for this purpose. Users of this
Due to how so few terminals actually support source location hyperlinks, pretty much tilix and intellij terminal are
the only two that really provide adequate functionality, this logging library defaults to output format that works
best with intellij. As such, the terminal is aware of the CWD and the code locations printed are relative, as
required to get the hyperlinkization from this terminal. Handling support for Tilix requires more complications and
due to advances with IntelliJ's handling it is not practical to support any other for this purpose. Users of this
library can always fall back to manually interpreting and accessing the relative file path to find the source of a log.
In addition, due to this terminal's slow rendering of long lines, long log strings are automatically broken into 80
character lines, and if there is comma separators in the line, the line is broken at the comma instead of at
In addition, due to this terminal's slow rendering of long lines, long log strings are automatically broken into 80
character lines, and if there is comma separators in the line, the line is broken at the comma instead of at
column80. This works perfectly for this purpose.

3
pkg/readme.adoc Normal file
View File

@@ -0,0 +1,3 @@
= pkg
go libraries shared by clients and relays

3
pkg/readme.md
View File

@@ -1,3 +0,0 @@
# pkg
go libraries shared by clients and relays

3
relays/readme.adoc Normal file
View File

@@ -0,0 +1,3 @@
= relays
relay implementations for various subprotocols

3
relays/readme.md
View File

@@ -1,3 +0,0 @@
# relays
relay implementations for various subprotocols

3
repos/readme.adoc Normal file
View File

@@ -0,0 +1,3 @@
= relays
relay implementations for various subprotocols

3
repos/readme.md
View File

@@ -1,3 +0,0 @@
# relays
relay implementations for various subprotocols