improve readme

This commit is contained in:
Green Sky 2023-01-17 16:06:20 +01:00
parent 4ee1a865aa
commit 5d4108c3e6
No known key found for this signature in database
2 changed files with 14 additions and 1 deletions

View File

@ -1,6 +1,19 @@
# Tool to send and receive files using Tox NGC FileTransfers
currently on prototype FT1
## Example
### sender (seeder)
$ tox_ngc_ft1_tool -F sender.tox -G <ngc_chat_id> -a sha1_info -f file_to_transfer
this will print this tools tox_id and the generated info_hash
### receivers (leechers)
$ tox_ngc_ft1_tool -F sender.tox -G <ngc_chat_id> -a sha1_info -D <info_hash>
this will first download the info using the info_hash and then all the file chunks listed in the info
while simultaneously resharing allready downloaded chunks and info (swarming)
## Usage
```

View File

@ -178,7 +178,7 @@ void CommandLine::printHelp(void) {
<< " --ft_sending_resend_without_ack_after\n"
<< " --ft_sending_give_up_after\n"
<< " --ft_packet_window_size\n"
<< "\n"
<< " transfer logic:\n"
<< " TODO\n"
;