ncg/README.md

39 lines
1.2 KiB
Markdown
Raw Normal View History

# ncg
_ncg_ was developed to be a custom client backend for the [netclient](https://git.rawtext.club/sloum/netclient) vim plugin. It supports gopher, gemini, and http(s).
2023-07-05 23:09:23 +00:00
Pass a url, get a text rendering back (ie. not the html/gophermap/gemtext source).
## Gopher/Gemini Query Responses
If a gemini request returns a type `10` response (a request for information from the user) the meta of the response (the question being asked) will be printed and the exist status will be `2`. This is specifically to allow other programs to see the question being posed and know that it is from a gemini request. They can then query for the response and resubmit with the correct querystring.
Like the above with gemini, if a gopher request is of type `7` (a request for information from the user) `Query: ` will be printed and the exit status will be `3`
## Other codes
An exist status of `1` indicates a general error and the text printed to the screen will be the error message.
## Run
```
ncg http://some-address.tld
```
2023-07-05 23:09:23 +00:00
## Buid/Install
A <a href="https://golang.org" target="_blank">go</a> compiler is required to build.
```
go build
```
2023-07-05 23:09:23 +00:00
```
go install
```
## License
FFSL