Skip to content

Update src/README.md to add main files explanation #809

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Update src/README.md to add main files explanation #809

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ebb642a
Update src/README.md to add file explanation
e10101 Sep 24, 2023
5a6e105
Update README.md file
e10101 Sep 24, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 26 additions & 1 deletion src/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Source code
# Source Code

## Dictionary

Expand All @@ -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