add readme and todo

[clo] / README.md

diff --git a/README.md b/README.md
index 46dfc11a5ead18e67be6883476ce8c4f99cc627b..0695958d0657f9ba596d7c53a6bbb754ca76b62e 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,7 +1,8 @@
 # clo
-another personal draught of a typesetting language and engine.
-website: https://kianting.info/wiki/w/Project:Clo
-License: MIT 
+ - another personal draught of a typesetting language and engine.
+ - website: https://kianting.info/wiki/w/Project:Clo
+ - license: MIT 
+ - issue tracking mailing list: `clo@kianting.info`
 
 ## changing journal
  - 20230904 建立 thenDo、matchRange的函數、refactor harfbuzzjs 以及libpdf 等測試界面
@@ -31,6 +32,9 @@ License: MIT
  - 20231023-24:fix .ttc bug.
  - 20231026-27 : clo basic interface, preprocessor of stream of text,
   add cjk-english splitter, etc.
+ - 20231029-30: hyphenating for english.
+ - TODO：利用harfbuzz算文字的對應px寬度
+
 
  ## 之後的做法
   - 先做一個前處理註冊器，註冊下列的前處理
@@ -43,15 +47,20 @@ License: MIT
     - 然後算出每個Box的x, y, page
     - 最後納入排版
 
-## 排版語法：
+## 排版語法
 
 使用lisp表示，但其實是陣列
 ```lisp
   (hglue 寬度 伸展值)
   (vglue 高度 伸展值)
-  (breakpoint 原始模式 斷行模式)
+  (bp 原始模式 斷行模式) ; breakpoint
+  (nl) ; newline
   (em 數字)
   (ex 數字)
   (span {"font-family" : "Noto Sans" , "font-size" : 16 })
   (vbox 高度 內容)
-```
\ No newline at end of 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