diff --git a/src/README.md b/src/README.md index 1c98af273..d92a466e3 100644 --- a/src/README.md +++ b/src/README.md @@ -1,4 +1,4 @@ -# Source code +# Source Code ## Dictionary @@ -16,3 +16,28 @@ * DictGroup: A wrap of a group of dictionaries. Iterates one by one until a match. ## Conversion + +## Main Files + +- Lexicon: Storage of all entries +- BinaryDict: Binary dictionary for faster deserialization +- CmdLineOutput: Output command line usage +- Common: Common definitions +- Config: Configuration loader +- Conversation: Conversion interface +- Converter: Controller of segmentation and conversion +- DartsDict: Darts dictionary +- Dict: Abstract class of dictionary +- DictConverter: Converts a dictionary from a format to another. +- DictEntry: Key-values pair entry +- DictGroup: Group of dictionaries +- Exception: Exceptions +- MarisaDict: Marisa dictionary. +- MaxMatchSegmentation: Implementation of maximal match segmentation +- Segmentation: Abstract segmentation +- Segments: Segmented text +- SerializableDict: Serializable dictionary interface +- SerializedValues: Binary format for dictionary values serialization. +- SimpleConverter: A high level converter +- TextDict: Text dictionary +- UTF8Util: UTF8 std::string utilities