Skip to content

Commit

Permalink
Finish README and do some correct
Browse files Browse the repository at this point in the history
  • Loading branch information
Martin Zhou authored and Martin Zhou committed Aug 14, 2015
1 parent 0afcd8a commit 9305e6f
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 3 deletions.
41 changes: 40 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,42 @@
# ftrans

ftrans is a simple file translator for LAN
ftrans -- A simple file transmitter program

Introducing

ftrans is designed in order to transmit one single file from a machine
to another.ftrans's design target is a lightweight,quick-to-use and
extremly simple file transmitter so it doesn't consider other things
like safety.

usage: main.py [-h] [-s SENDTO] [-r] [-f FILE] [-b BLOCK_SIZE] [-t TIMEOUT]
[-i]

optional arguments:
-h, --help show this help message and exit
-s SENDTO, --sendto SENDTO
specify receiver's ip address
-r, --receive receive file
-f FILE, --file FILE the path of to-be-transmitted file
-b BLOCK_SIZE, --block-size BLOCK_SIZE
set transmitting block size
-t TIMEOUT, --timeout TIMEOUT
set time out value by seconds
-i, --info show license and author information

License

Copyright 2015 Zumium <[email protected]>

ftrans is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

ftrans is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with ftrans. If not, see <http://www.gnu.org/licenses/>.
4 changes: 2 additions & 2 deletions ftrans/main.py
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@ def main():
parser=argparse.ArgumentParser()
parser.add_argument('-s','--sendto',help="specify receiver's ip address")
parser.add_argument('-r','--receive',help='receive file',action='store_true')
parser.add_argument('-f','--file',help='the path of to-be-transforred file')
parser.add_argument('-b','--block-size',help='set internet transfor block size')
parser.add_argument('-f','--file',help='the path of to-be-transmitted file')
parser.add_argument('-b','--block-size',help='set transmitting block size')
parser.add_argument('-t','--timeout',type=int,help='set time out value by seconds')
parser.add_argument('-i','--info',help='show license and author information',action='store_true')
args=parser.parse_args()
Expand Down

0 comments on commit 9305e6f

Please sign in to comment.