X-Git-Url: https://git.kianting.info/?a=blobdiff_plain;f=README.md;h=cfa3a063add9eb699547ec75e9988e2b21eadebd;hb=f33568e79c6b4454dc378c61e5f4f4c860390481;hp=3a17a56e5fd8a8955c76ca0df234ae5a67d89786;hpb=c3dc58d74afa6b298d84bad90d63c027a32a954a;p=clo

diff --git a/README.md b/README.md
index 3a17a56..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`),
@@ -32,7 +39,12 @@
  - 20231023-24:fix .ttc bug.
  - 20231026-27 : clo basic interface, preprocessor of stream of text,
   add cjk-english splitter, etc.
- - 20231029: hyphenating for english.
+ - 20231029-30: hyphenating for english.
+ - 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
 
  ## 之後的做法
   - 先做一個前處理註冊器，註冊下列的前處理
@@ -60,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