StarMirror/tars2node
1
0
Fork 0
mirror of https://github.com/tars-node/tars2node.git synced 2024-03-22 13:10:56 +08:00
Code Issues Projects Releases Wiki Activity

update: readme format

Browse Source
This commit is contained in:
Super Zheng 2018-07-27 12:34:50 +08:00
parent deaeeb550b
commit fac221d810
1 changed files with 16 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
README.md
View File

@ -15,23 +15,22 @@ tars2node [OPTIONS] tarsfile
## 选项 ## 选项
> Options: > Options:
> --version print tars2node version.
> --version print tars2node version > --rpc-path=[DIRECTORY] specify the path of rpc module.
> --rpc-path=[DIRECTORY] specify the path of rpc module. > --stream-path=[DIRECTORY[] specify the path of stream module.
> --stream-path=[DIRECTORY[] specify the path of stream module. > --allow-reserved-namespace allow you to use reserved word as a namespace.
> --allow-reserved-namespace allow you to use reserved word as a namespace. > --dir=DIRECTORY generate source file to DIRECTORY.
> --dir=DIRECTORY generate source file to DIRECTORY. > --relative use current path.
> --relative use current path. > --tarsBase=DIRECTORY where to search tars files.
> --tarsBase=DIRECTORY where to search tars files. > --r generate source all tars files.
> --r generate source all tars files. > --r-minimal minimize the dependent members.
> --r-minimal minimize the dependent members. > --r-reserved list of names(split by ",") that should be keeped.
> --r-reserved list of names(split by ",") that should be keeped. > --client just for client side source file.
> --client just for client side source file. > --server just for server side source file.
> --server just for server side source file. > --dts generate d.ts file.
> --dts generate d.ts file. > --use-string-represent use string represent long type.
> --use-string-represent use string represent long type. > --string-binary-encoding get string raw bytes <BinBuffer>.
> --string-binary-encoding get string raw bytes <BinBuffer>. > --optimize=[0|s] support "s" to reduce code size, default is 0.
> --optimize=[0|s] support "s" to reduce code size, default is 0.
## 从源码编译 ## 从源码编译