From 2269879a2e946be08330341854d5d5ec9d295bb3 Mon Sep 17 00:00:00 2001 From: Peter Cai Date: Wed, 23 Aug 2017 11:22:33 +0800 Subject: [PATCH] doc: note about comments --- README.md | 5 +++++ doc/README.zh-cn.md | 3 +++ 2 files changed, 8 insertions(+) diff --git a/README.md b/README.md index fc63cb3..45ffd42 100755 --- a/README.md +++ b/README.md @@ -74,7 +74,12 @@ For example, rewrite the options for the above `server` example into configurati ``` -s +# You can add comments like this +# Comments MUST occupy an entire line +# Or they will not work as expected +# Listen address -l 0.0.0.0:4096 +# Remote address -r 127.0.0.1:7777 -a -k passwd diff --git a/doc/README.zh-cn.md b/doc/README.zh-cn.md index 1423c6e..8a39542 100644 --- a/doc/README.zh-cn.md +++ b/doc/README.zh-cn.md @@ -90,6 +90,9 @@ https://github.com/wangyu-/udp2raw-tunnel/releases ``` -s +# 你可以像这样添加注释 +# 注意，只有整行注释才能在配置文件里使用 +# 注释必须独占一行 -l 0.0.0.0:4096 -r 127.0.0.1:7777 -a