diff --git a/README.md b/README.md index 12e1b871..7d4fc114 100644 --- a/README.md +++ b/README.md @@ -58,6 +58,16 @@ If Qt's version is not changed, you can also download a single `goldendict.exe` One of the `.dmg` installers. +## Help GoldenDict's Development + +GoldenDict is developed by volunteers. + +All kinds of help like answering questions, bug reporting, testing, translation and coding are welcomed. + +To translate the interface, you can use the Crowdin + +To start development, check out [developer guide](https://xiaoyifang.github.io/goldendict-ng/developer/) + ## Build from source ### Dependencies @@ -187,11 +197,6 @@ qmake "CONFIG+=use_iconv" when enabled ,iconv should be installed on the platform at the same time. - -## Contributing - -All kinds of help like answering questions, bug reporting, testing, translation and coding are welcomed. - ## Support Bug reporting: [GoldenDict issue tracker](https://github.com/xiaoyifang/goldendict-ng/issues) diff --git a/website/docs/developer.md b/website/docs/developer.md index 7b5de6f5..bea17c17 100644 --- a/website/docs/developer.md +++ b/website/docs/developer.md @@ -18,4 +18,12 @@ Commit messages should follow [Conventional Commits](https://www.conventionalcom Reformat changes with `clang-format` [how to use clang-format](https://github.com/xiaoyifang/goldendict/blob/staged/howto/how%20to%20use%20.clang-format%20to%20format%20the%20code.md) -Remember to enable `clang-tidy` support on your editor so that `.clang-tidy` will be respected. \ No newline at end of file +Remember to enable `clang-tidy` support on your editor so that `.clang-tidy` will be respected. + +## Architecture + +What's under the hood after a word is queried? + +After typing a word into the search box and press enter, the embedded browser will load `gdlookup://localhost?word=`. This url will be handled by Qt webengine's Url Scheme handler. The returned html page will be composed in the ArticleMaker which will initiate some DataRequest on dictionary formats. Resource files will be requested via `bres://` or `qrc://` which will went through a similar process. + +TODO: other subsystems. \ No newline at end of file