hashirama/goldendict-ng
hashirama/goldendict-ng
0
0
Fork 0
mirror of https://github.com/xiaoyifang/goldendict-ng.git synced 2024-11-24 00:14:06 +00:00
Code Issues Actions 1 Projects Releases Wiki Activity

docs: update "contributing"

Browse source
This commit is contained in:
shenleban tongying 2023-04-29 11:09:15 -04:00 committed by xiaoyifang
parent 94759ffb58
commit 251bd06c4d
2 changed files with 19 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
README.md
View file

@ -58,6 +58,16 @@ If Qt's version is not changed, you can also download a single `goldendict.exe`
One of the `.dmg` installers. 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 <https://crowdin.com/project/goldendict-ng>
To start development, check out [developer guide](https://xiaoyifang.github.io/goldendict-ng/developer/)
## Build from source ## Build from source
### Dependencies ### Dependencies
@ -187,11 +197,6 @@ qmake "CONFIG+=use_iconv"
when enabled ,iconv should be installed on the platform at the same time. 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 ## Support
Bug reporting: [GoldenDict issue tracker](https://github.com/xiaoyifang/goldendict-ng/issues) Bug reporting: [GoldenDict issue tracker](https://github.com/xiaoyifang/goldendict-ng/issues)

10
website/docs/developer.md
View file

@ -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) 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. 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=<wantted 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.