sloum
/
ncg
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Updates readme

This commit is contained in:
sloum 2024-01-24 14:59:23 -08:00
parent 6ae86678ae
commit 63a583b924
1 changed files with 22 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@ -1,6 +1,6 @@
# 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).
_ncg_ was developed to be a custom client backend for the [netclient](https://tildegit.org/sloum/netclient) vim plugin. It supports gopher, gemini, and http(s).
Pass a url, get a text rendering back (ie. not the html/gophermap/gemtext source).
@ -15,6 +15,27 @@ Like the above with gemini, if a gopher request is of type `7` (a request for in
An exist status of `1` indicates a general error and the text printed to the screen will be the error message.
## Using with vim netclient plugin
In your `.vimrc` add the following:
```vimscript
let g:netclient_command = "ncg %s"
```
Make sure that the `ncg` binary is on your `$PATH`.
If you have not already set your leader, you will want to do so (also in your `.vimrc`):
```vimscript
let g:netclient_leader = " "
```
The above sets a double space to be the netclient leader. Use whatever you like, but I find that comfortable. Once all that is done, you can open up vim to an empty document (or an existing one) and press `<space><space>o`. It will query for the URL you would like to visit. You use vim's undo for `back` and redo for `forward`. You can press a number for a given link followed by the follow command. So to follow link #5 do `5<space><space>f`.
Have fun :-D
## Run
```