]> git.kianting.info Git - clo/blobdiff - README.md
update docs
[clo] / README.md
index eac51bbf3807c4d78c12c7e0942ed9bd4438f117..cfa3a063add9eb699547ec75e9988e2b21eadebd 100644 (file)
--- a/README.md
+++ b/README.md
@@ -5,10 +5,11 @@
  - issue tracking mailing list: `clo@kianting.info`
 
 ## How to use
-cd /path/to/clo
-node . [.clo FILE] --output-js=[.js FILE]
-node [.js FILE]
-
+```
+  cd /path/to/clo
+  node . [.clo FILE] --output-js=[.js FILE]
+  node [.js FILE]
+```
 
 ## changing journal
  - 20230904 建立 thenDo、matchRange的函數、refactor harfbuzzjs 以及libpdf 等測試界面
@@ -71,5 +72,8 @@ node [.js FILE]
 ```
 
 ## 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