添加中文版readme

Author: Went-Liang

README.md

@@ -8,7 +8,7 @@
 <p align="center">
   <img src="https://repository-images.githubusercontent.com/254842585/4dfa7580-7ffb-11ea-99d0-46b8fe2f4170" height="175" width="auto" />
 </p>
-
+[中文版](README_CN.md)
 # ModernCppStarter
 
 Setting up a new C++ project usually requires a significant amount of preparation and boilerplate code, even more so for modern C++ projects with tests, executables and continuous integration.

README_CN.md

@@ -0,0 +1,209 @@
+[![Actions Status](https://github.com/TheLartians/ModernCppStarter/workflows/MacOS/badge.svg)](https://github.com/TheLartians/ModernCppStarter/actions)
+[![Actions Status](https://github.com/TheLartians/ModernCppStarter/workflows/Windows/badge.svg)](https://github.com/TheLartians/ModernCppStarter/actions)
+[![Actions Status](https://github.com/TheLartians/ModernCppStarter/workflows/Ubuntu/badge.svg)](https://github.com/TheLartians/ModernCppStarter/actions)
+[![Actions Status](https://github.com/TheLartians/ModernCppStarter/workflows/Style/badge.svg)](https://github.com/TheLartians/ModernCppStarter/actions)
+[![Actions Status](https://github.com/TheLartians/ModernCppStarter/workflows/Install/badge.svg)](https://github.com/TheLartians/ModernCppStarter/actions)
+[![codecov](https://codecov.io/gh/TheLartians/ModernCppStarter/branch/master/graph/badge.svg)](https://codecov.io/gh/TheLartians/ModernCppStarter)
+
+<p align="center">
+  <img src="https://repository-images.githubusercontent.com/254842585/4dfa7580-7ffb-11ea-99d0-46b8fe2f4170" height="175" width="auto" />
+</p>
+[英文版](README.md)
+# ModernCppStarter
+
+创建一个新的C++项目通常需要大量的准备工作和模板代码，尤其是对于有测试、可执行文件和持续集成的现代C++项目而言。
+这个模板是从多个以前的项目中获得的经验总结，应该有助于减少设置一个现代C++项目所需的工作量。
+
+## Features
+
+- [现代 CMake 实践](https://pabloariasal.github.io/2018/02/19/its-time-to-do-cmake-right/)
+- 适用于任何规模项目，无论单头文件库还是大型项目
+- 库和可执行代码的干净分离
+- 集成测试套件
+- 通过[GitHub Actions](https://help.github.com/en/actions/)实现持续集成CI：使用GitHub的自动化工具，每次代码更改时都会触发一系列的测试、构建和部署任务
+- 通过[codecov](https://codecov.io)进行代码覆盖率分析：分析测试套件覆盖了多少代码，帮助开发者找出未被测试覆盖的代码部分
+- 通过 [Format.cmake](https://github.com/TheLartians/Format.cmake)强制使用[clang-format](https://clang.llvm.org/docs/ClangFormat.html)和 [cmake-format](https://github.com/cheshirekow/cmake_format)规范代码格式 
+- 通过 [CPM.cmake](https://github.com/TheLartians/CPM.cmake)实现可重复的依赖管理：管理项目的依赖，确保在不同环境或不同时间构建项目时，依赖的版本都是一致的
+
+- 通过[PackageProject.cmake](https://github.com/TheLartians/PackageProject.cmake)生成可安装的目标，并自动包含版本信息和头文件
+- 使用 [Doxygen](https://www.doxygen.nl)  和 [GitHub Pages](https://pages.github.com) 自动实现[documentation](https://thelartians.github.io/ModernCppStarter)和部署：Doxygen是一个用于从源代码中生成文档的工具，而GitHub Pages则是一个用于托管静态网页的平台。结合两者，可以自动地从代码生成文档，并部署到网页上供人查阅
+- 支持 [sanitizer tools等](#additional-tools)：sanitizer工具通常用于内存错误检测，如地址越界、内存泄漏等。这个功能意味着该工具或框架集成了对这类工具的支持，以帮助开发者更好地检测代码中的潜在问题
+
+## Usage
+
+### Adjust the template to your needs
+
+- Use this repo [as a template](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-repository-from-a-template).
+- Replace all occurrences of "Greeter" in the relevant CMakeLists.txt with the name of your project
+  - Capitalization matters here: `Greeter` means the name of the project, while `greeter` is used in file names.
+  - Remember to rename the `include/greeter` directory to use your project's lowercase name and update all relevant `#include`s accordingly.
+- Replace the source files with your own
+- For header-only libraries: see the comments in [CMakeLists.txt](CMakeLists.txt)
+- Add [your project's codecov token](https://docs.codecov.io/docs/quick-start) to your project's github secrets under `CODECOV_TOKEN`
+- Happy coding!
+
+Eventually, you can remove any unused files, such as the standalone directory or irrelevant github workflows for your project.
+Feel free to replace the License with one suited for your project.
+
+To cleanly separate the library and subproject code, the outer `CMakeList.txt` only defines the library itself while the tests and other subprojects are self-contained in their own directories. 
+During development it is usually convenient to [build all subprojects at once](#build-everything-at-once).
+
+### Build and run the standalone target
+
+Use the following command to build and run the executable target.
+
+```bash
+cmake -S standalone -B build/standalone
+cmake --build build/standalone
+./build/standalone/Greeter --help
+```
+
+### Build and run test suite
+
+Use the following commands from the project's root directory to run the test suite.
+
+```bash
+cmake -S test -B build/test
+cmake --build build/test
+CTEST_OUTPUT_ON_FAILURE=1 cmake --build build/test --target test
+
+# or simply call the executable: 
+./build/test/GreeterTests
+```
+
+To collect code coverage information, run CMake with the `-DENABLE_TEST_COVERAGE=1` option.
+
+### Run clang-format
+
+Use the following commands from the project's root directory to check and fix C++ and CMake source style.
+This requires _clang-format_, _cmake-format_ and _pyyaml_ to be installed on the current system.
+
+```bash
+cmake -S test -B build/test
+
+# view changes
+cmake --build build/test --target format
+
+# apply changes
+cmake --build build/test --target fix-format
+```
+
+See [Format.cmake](https://github.com/TheLartians/Format.cmake) for details.
+These dependencies can be easily installed using pip.
+
+```bash
+pip install clang-format==14.0.6 cmake_format==0.6.11 pyyaml
+```
+
+### Build the documentation
+
+The documentation is automatically built and [published](https://thelartians.github.io/ModernCppStarter) whenever a [GitHub Release](https://help.github.com/en/github/administering-a-repository/managing-releases-in-a-repository) is created.
+To manually build documentation, call the following command.
+
+```bash
+cmake -S documentation -B build/doc
+cmake --build build/doc --target GenerateDocs
+# view the docs
+open build/doc/doxygen/html/index.html
+```
+
+To build the documentation locally, you will need Doxygen, jinja2 and Pygments installed on your system.
+
+### Build everything at once
+
+The project also includes an `all` directory that allows building all targets at the same time.
+This is useful during development, as it exposes all subprojects to your IDE and avoids redundant builds of the library.
+
+```bash
+cmake -S all -B build
+cmake --build build
+
+# run tests
+./build/test/GreeterTests
+# format code
+cmake --build build --target fix-format
+# run standalone
+./build/standalone/Greeter --help
+# build docs
+cmake --build build --target GenerateDocs
+```
+
+### Additional tools
+
+The test and standalone subprojects include the [tools.cmake](cmake/tools.cmake) file which is used to import additional tools on-demand through CMake configuration arguments.
+The following are currently supported.
+
+#### Sanitizers
+
+Sanitizers can be enabled by configuring CMake with `-DUSE_SANITIZER=<Address | Memory | MemoryWithOrigins | Undefined | Thread | Leak | 'Address;Undefined'>`.
+
+#### Static Analyzers
+
+Static Analyzers can be enabled by setting `-DUSE_STATIC_ANALYZER=<clang-tidy | iwyu | cppcheck>`, or a combination of those in quotation marks, separated by semicolons.
+By default, analyzers will automatically find configuration files such as `.clang-format`.
+Additional arguments can be passed to the analyzers by setting the `CLANG_TIDY_ARGS`, `IWYU_ARGS` or `CPPCHECK_ARGS` variables.
+
+#### Ccache
+
+Ccache can be enabled by configuring with `-DUSE_CCACHE=<ON | OFF>`.
+
+## FAQ
+
+> Can I use this for header-only libraries?
+
+Yes, however you will need to change the library type to an `INTERFACE` library as documented in the [CMakeLists.txt](CMakeLists.txt).
+See [here](https://github.com/TheLartians/StaticTypeInfo) for an example header-only library based on the template.
+
+> I don't need a standalone target / documentation. How can I get rid of it?
+
+Simply remove the standalone / documentation directory and according github workflow file.
+
+> Can I build the standalone and tests at the same time? / How can I tell my IDE about all subprojects?
+
+To keep the template modular, all subprojects derived from the library have been separated into their own CMake modules.
+This approach makes it trivial for third-party projects to re-use the projects library code.
+To allow IDEs to see the full scope of the project, the template includes the `all` directory that will create a single build for all subprojects.
+Use this as the main directory for best IDE support.
+
+> I see you are using `GLOB` to add source files in CMakeLists.txt. Isn't that evil?
+
+Glob is considered bad because any changes to the source file structure [might not be automatically caught](https://cmake.org/cmake/help/latest/command/file.html#filesystem) by CMake's builders and you will need to manually invoke CMake on changes.
+  I personally prefer the `GLOB` solution for its simplicity, but feel free to change it to explicitly listing sources.
+
+> I want create additional targets that depend on my library. Should I modify the main CMakeLists to include them?
+
+Avoid including derived projects from the libraries CMakeLists (even though it is a common sight in the C++ world), as this effectively inverts the dependency tree and makes the build system hard to reason about.
+Instead, create a new directory or project with a CMakeLists that adds the library as a dependency (e.g. like the [standalone](standalone/CMakeLists.txt) directory).
+Depending type it might make sense move these components into a separate repositories and reference a specific commit or version of the library.
+This has the advantage that individual libraries and components can be improved and updated independently.
+
+> You recommend to add external dependencies using CPM.cmake. Will this force users of my library to use CPM.cmake as well?
+
+[CPM.cmake](https://github.com/TheLartians/CPM.cmake) should be invisible to library users as it's a self-contained CMake Script.
+If problems do arise, users can always opt-out by defining the CMake or env variable [`CPM_USE_LOCAL_PACKAGES`](https://github.com/cpm-cmake/CPM.cmake#options), which will override all calls to `CPMAddPackage` with the according `find_package` call.
+This should also enable users to use the project with their favorite external C++ dependency manager, such as vcpkg or Conan.
+
+> Can I configure and build my project offline?
+
+No internet connection is required for building the project, however when using CPM missing dependencies are downloaded at configure time.
+To avoid redundant downloads, it's highly recommended to set a CPM.cmake cache directory, e.g.: `export CPM_SOURCE_CACHE=$HOME/.cache/CPM`.
+This will enable shallow clones and allow offline configurations dependencies are already available in the cache.
+
+> Can I use CPack to create a package installer for my project?
+
+As there are a lot of possible options and configurations, this is not (yet) in the scope of this template. See the [CPack documentation](https://cmake.org/cmake/help/latest/module/CPack.html) for more information on setting up CPack installers.
+
+> This is too much, I just want to play with C++ code and test some libraries.
+
+Perhaps the [MiniCppStarter](https://github.com/TheLartians/MiniCppStarter) is something for you!
+
+## Related projects and alternatives
+
+- [**ModernCppStarter & PVS-Studio Static Code Analyzer**](https://github.com/viva64/pvs-studio-cmake-examples/tree/master/modern-cpp-starter): Official instructions on how to use the ModernCppStarter with the PVS-Studio Static Code Analyzer.
+- [**cpp-best-practices/gui_starter_template**](https://github.com/cpp-best-practices/gui_starter_template/): A popular C++ starter project, created in 2017.
+- [**filipdutescu/modern-cpp-template**](https://github.com/filipdutescu/modern-cpp-template): A recent starter using a more traditional approach for CMake structure and dependency management.
+- [**vector-of-bool/pitchfork**](https://github.com/vector-of-bool/pitchfork/): Pitchfork is a Set of C++ Project Conventions.
+
+## Star History
+
+[![Star History Chart](https://api.star-history.com/svg?repos=TheLartians/ModernCppStarter,cpp-best-practices/gui_starter_template,filipdutescu/modern-cpp-template&type=Date)](https://star-history.com/#TheLartians/ModernCppStarter&cpp-best-practices/gui_starter_template&filipdutescu/modern-cpp-template&Date)