update docs

[clo] / README.md

diff --git a/README.md b/README.md
index b5717d26adf43118440514be0aa93f3941801492..cfa3a063add9eb699547ec75e9988e2b21eadebd 100644 (file)
--- 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`),
@@ -36,6 +43,8 @@
  - 20231105-06: 利用fontkit算文字的對應px寬度 initially pushed.
  - 20231109-10: Keng-kái oa̍h-chōa ián-sǹg-hoat.
  - 20231113: the algorithm is basically fixed, and make a `bigFrame` to prepare for convert to boxes and positions.
+ - 20231115-16: grid and basic types laying.
+ - 231120 fix the line-breaking algorithm
 
  ## 之後的做法
   - 先做一個前處理註冊器，註冊下列的前處理
@@ -63,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