Add comprehensive docs & example .schema.yaml file with all available configuration #1031
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
感謝拾柴。 doc/example.schema.yaml 相比之下文檔和示例對用家更有幫助。 在 WIki 開闢一個頁面如何？ Wiki 比代碼更方便在線編輯，且可以與已有文檔互相引用。 https://github.com/LEOYoon-Tsaw/Rime_collections/blob/master/Rime_description.md |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pull request
Add
example.schema.yamlfile with all available configurations and their types.Temporarily generated a comprehensive document about different components with AI.
Some other notes
Issue tracker
Fixes will automatically close the related issue: none
Feature
Describe feature of pull request: as stated above
Unit test
Manual test
Code Review
Additional Info
中州韻的各位開發者你好，我是來自臺灣的網頁開發者，叫做哈洛斯 (Harlos) 。若此 Pull Request 驚動或冒犯到各位我非常抱歉，但做為一名開發者 (程序員) 我想要為這偉大的專案貢獻一份心力。
最近透過開發者同好發現了小狼毫輸入法，以及它背後的引擎——中州韻 (RIME) 。我在研究輸入法設定檔時遇到了困難，但是卻找不到相關的定義文件。於是我找到了這個專案，並徹夜研讀程式碼。讓我意外的是，即使已經多年沒有接觸 C/C++ 的我，居然還算是能看懂，而這也要歸功於各位開發者乾淨清晰的架構。
然而我的能力還是有限，所以先暫時透過搜尋找到所有使用設定檔之處，整理好成範例設定檔，並且暫時請 AI 協助分析這些元件的功能。如果各位開發者願意，歡迎來給予建議與修正。如果我的行為違反你們的開發流程或習慣，也請務必告知我。
我認為這樣的文件能夠幫助更多人更容易了解中州韻背後的運作原理，並更能夠輕易地自訂輸入法，甚至開發出新的輸入法。作為全職開發者時間和精力很有限，雖然能做的不多，但希望如此能拋磚引玉。先在此感謝各位的閱讀。