update documentation link

[clo] / README.md

diff --git a/README.md b/README.md
index b5717d26adf43118440514be0aa93f3941801492..08afd1d9be088c624564ce0c63873065084c2658 100644 (file)
--- a/README.md
+++ b/README.md
@@ -2,8 +2,16 @@
  - another personal draught of a typesetting language and engine.
  - website: https://kianting.info/wiki/w/Project:Clo
  - license: MIT 
+ - docs : https://kianting.info/wiki/w/Project:Clo
  - 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 +44,9 @@
  - 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.
+ - 20231120: fix the line-breaking algorithm
+ - 20231125: multiple paragraph basic
 
  ## 之後的做法
   - 先做一個前處理註冊器，註冊下列的前處理
@@ -55,7 +66,7 @@
   (hglue 寬度 伸展值)
   (vglue 高度 伸展值)
   (bp 原始模式 斷行模式) ; breakpoint
-  (nl) ; newline
+  (br) ; force newline
   (em 數字)
   (ex 數字)
   (span {"font-family" : "Noto Sans" , "font-size" : 16 })
@@ -63,5 +74,11 @@
 ```
 
 ## 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`.
+
+   - set the referee source to my repo:
+   - `typedoc --sourceLinkTemplate "https://git.kianting.info/?p=clo;a=blob;f={path};hb=HEAD#l{line}" /path/to/src1 ...`
+
+store the documents
+ - `rsync /path/to/docs host@/var/www/docs`
\ No newline at end of file