X-Git-Url: https://git.kianting.info/?a=blobdiff_plain;f=README.md;h=cfa3a063add9eb699547ec75e9988e2b21eadebd;hb=f33568e79c6b4454dc378c61e5f4f4c860390481;hp=4328f63fcd866a3ddc329ce5ef4e7850fc7174c9;hpb=433dcacba24d58fec00e81fac19cf7f236fedc32;p=clo

diff --git a/README.md b/README.md
index 4328f63..cfa3a06 100644
--- a/README.md
+++ b/README.md
@@ -4,6 +4,13 @@
  - license: MIT 
  - issue tracking mailing list: `clo@kianting.info`
 
+## How to use
+```
+  cd /path/to/clo
+  node . [.clo FILE] --output-js=[.js FILE]
+  node [.js FILE]
+```
+
 ## changing journal
  - 20230904 建立 thenDo、matchRange的函數、refactor harfbuzzjs 以及libpdf 等測試界面
  - 20230905-06: 建立 : `toSome`, initial of basic tokenizer (`tokenize`),
@@ -65,5 +72,8 @@
 ```
 
 ## How to generate documents
- - `typedoc /path/to/index.js [/path/to/index2.js ...]`
-the generated page will be stored in `/src`.
\ No newline at end of file
+ - `typedoc /path/to/src1 [/path/to/another/src/or/.js ...]`
+the generated page will be stored in `/docs`.
+
+store the documents
+ - `rsync /path/to/docs host@/var/www/docs`
\ No newline at end of file