Update README

justinsilvestre · Sep 12, 2024 · 9b40e64 · 9b40e64
1 parent 9b22d08
commit 9b40e64
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -2,6 +2,22 @@
 
 This is a project to make a library of free interactive texts for learners of classical/literary Chinese.
 
+# features
+
+Texts are shown with an interactive English translation. **Click on any character** to see its English translations in a pop-up dictionary, with its **meaning in the current context** highlighted explicitly, to make texts easy to understand.
+
+![popup dictionary and interactive word highlighting](docs/popup_dictionary_and_word_highlighting.png)
+
+Words and set expressions **consisting of multiple characters** are glossed as well.
+
+![alt text](docs/multi_character_word_gloss.png)
+
+This all works through a **domain-specific language** for glossing Chinese texts. It is inspired by the conventions of [*kanbun kundoku*](https://en.wikipedia.org/wiki/Kanbun), a traditional Japanese technique for translating and glossing classical/literary Chinese texts.
+
+![demonstrating the gloss-editing UI](docs/editing_source.png)
+
+A variety of pronunciation schemes are available to choose from, so as to make Hanlib a valuable resource for people throughout the [Sinosphere](https://en.wikipedia.org/wiki/Sinosphere) and beyond.
+
 # current focus
 
 The current focus is to transcribe + format the content of the 1927 textbook _Introduction to Literary Chinese_ by J. Brandt. This book is in the public domain in the US. You can access a digitized copy from a US IP address here:

diff --git a/docs/editing_source.png b/docs/editing_source.png
diff --git a/docs/multi_character_word_gloss.png b/docs/multi_character_word_gloss.png
diff --git a/docs/popup_dictionary_and_word_highlighting.png b/docs/popup_dictionary_and_word_highlighting.png