goldendict-ng/website/docs/developer.md

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

35 lines
1 KiB
Markdown
Raw Normal View History

2023-04-16 00:53:40 +00:00
Developing GoldenDict is not hard.
If you know some C++ and optionally some Qt, you can start to modify GoldenDict right now:
2024-07-10 02:47:05 +00:00
## Install Qt and QtCreator
2024-07-10 02:46:16 +00:00
(On Linux, install dependencies)
Windows(qtcreator for example)
2024-07-10 02:57:39 +00:00
### Prerequisite
Install visual studio community ,choose C++ component.
QtCreator Packages:
2024-07-10 02:46:16 +00:00
```
[x]qtX.X.X version
[x]MSVC2019 /GCC
[x]Qt5 Compatible Module
[*]Additional
[x]Qt Image formats
[x]Qt MultiMedia
[x]Qt Positioning
[x]Qt speech
[x]Qt webchannel
[x]Qt webengine
```
2023-04-16 00:53:40 +00:00
## Coding Standards
Please follow [C++ Core Guidelines](https://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines) and write modern C++ code.
Commit messages should follow [Conventional Commits](https://www.conventionalcommits.org)
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)
2024-07-10 02:46:16 +00:00
Remember to enable `clang-tidy` support on your editor so that `.clang-tidy` will be respected.