switch all the things to asciidoc

This commit is contained in:
2025-02-02 18:38:57 -01:06
parent 9914469cc2
commit abf02e9e0d
9 changed files with 28 additions and 26 deletions

3
clients/readme.adoc Normal file
View File

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

View File

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

View File

@@ -1,27 +1,29 @@
# 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

3
pkg/readme.adoc Normal file
View File

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

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

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

View File

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