已开启
新增英文readme文件 #19
xutao创建于 8月17日
新增英文readme文件 #19
已开启
共 1 个文件变更+106-0
| @@ -0,0 +1,106 @@ | |||
| 1 | +# Libirc | ||
| 2 | + | ||
| 3 | +Integrated remote console client libraries. | ||
| 4 | + | ||
| 5 | +# Windows Deployment Environment | ||
| 6 | +## 1. Visual Studio, CMake, OpenSSL, and Boost Source Code Required for Compilation (or Precompiled Version to Organize the Directory) | ||
| 7 | + | ||
| 8 | +### 1.1 Example Environment: Visual Studio 2022, Boost_1_87_0, CMake 4.0.1, and OpenSSL 3.5.0 | ||
| 9 | + | ||
| 10 | +`` | ||
| 11 | + After the environment is deployed, modify and configure the `config.ini` file based on the actual path. | ||
| 12 | + Decompress the Boost source code to the `.\boost_src` directory and ensure that the `.\boost_src\bootstrap.bat` file exists in the directory after decompression. | ||
| 13 | + Then, run `build.bat`. | ||
| 14 | + The executable file of the test tool is stored in the `bin` directory. | ||
| 15 | + The APIs we provide are generated as static libraries in the `libs` directory. | ||
| 16 | +`` | ||
| 17 | + | ||
| 18 | +## 2. API Development Description | ||
| 19 | + | ||
| 20 | +``` | ||
| 21 | + The `src` directory stores all API code. | ||
| 22 | + The test directory stores the test code of the API, which is classified by module. | ||
| 23 | +``` | ||
| 24 | + | ||
| 25 | +## 3. Deployment Guide | ||
| 26 | +``` | ||
| 27 | + `libirc` library deployment guide | ||
| 28 | +``` | ||
| 29 | + | ||
| 30 | +### 3.1 Deployment Overview: | ||
| 31 | +#### 3.1.1 Dependency Tools | ||
| 32 | +``` | ||
| 33 | + 1. Boost | ||
| 34 | + Note: It is recommended that you use version 1.82.0 or later. The build tool in the project can automatically build Boost. | ||
| 35 | + The example in this guide uses Boost 1.87.0. | ||
| 36 | + Download address: https://archives.boost.io/release/1.87.0/source/boost_1_87_0.7z | ||
| 37 | + | ||
| 38 | + 2. Visual Studio | ||
| 39 | + Note: The project needs to use the STL feature of the C++14 standard. Therefore, Visual Studio 2017 or later (community edition) is recommended. | ||
| 40 | + In this example, Visual Studio 2022 Community Edition is used. | ||
| 41 | + Download address: https://visualstudio.microsoft.com/vs/ | ||
| 42 | + | ||
| 43 | + 3. CMake | ||
| 44 | + Note: The earliest version required is 3.15. | ||
| 45 | + Download address: https://cmake.org/ | ||
| 46 | + | ||
| 47 | + 4. OpenSSL | ||
| 48 | + Note: The OpenSSL version must meet the requirements of Boost. OpenSSL 3.2.0 or later is recommended. | ||
| 49 | + Download address: https://slproweb.com/download/Win64OpenSSL-3_5_0.exe | ||
| 50 | +``` | ||
| 51 | + | ||
| 52 | +#### 3.1.2 Setting the Boost Source Code Directory | ||
| 53 | +``` | ||
| 54 | + 1. Decompress `boost_1_87_0.7z` to the root directory of the libirc code. | ||
| 55 | + 2. Change the name of the `boost_1_87_0` decompression directory in the `libirc` directory to `boost_src`. | ||
| 56 | + 3. After `build.bat` (build script) is executed, the boost directory is generated based on `boost_src`. | ||
| 57 | +``` | ||
| 58 | + | ||
| 59 | +#### 3.1.3 Configuring the `config.ini` File | ||
| 60 | +``` | ||
| 61 | + 1. The purpose is to enable `libirc` to find the compiler, OpenSSL path, and generator version through the configured path, avoiding complex environment variable settings. | ||
| 62 | + 2. Configuration field description: | ||
| 63 | + `C_COMPILER` # Path of the C compiler | ||
| 64 | + `CXX_COMPILER` # Path of the C++ compiler | ||
| 65 | + `OPENSSL_ROOT_DIR` # Root directory of OpenSSL | ||
| 66 | + `OPENSSL_INC` # OpenSSL header file directory | ||
| 67 | + `OPENSSL_LIB` # OpenSSL library directory, which must contain static libraries such as `crypto` and `ssl` | ||
| 68 | + `GENERATOR` # CMake project generator tool | ||
| 69 | +``` | ||
| 70 | + | ||
| 71 | +#### 3.1.4 Build Tool build.bat | ||
| 72 | +``` | ||
| 73 | + After the dependency environment is deployed, developers can directly run `build.bat` in the command line. | ||
| 74 | + The directory structure after the execution is as follows: | ||
| 75 | + . | ||
| 76 | + |-- bin # Binary library file directory of the example provided in the example (generated) | ||
| 77 | + |-- boost # Boost installation directory generated based on the source code in `boost_src` (generated) | ||
| 78 | + |-- boost_src # Stores the Boost source code (manually built during deployment) | ||
| 79 | + |-- build # CMake project build directory (generated) | ||
| 80 | + |-- example # Example provided in this project | ||
| 81 | + |-- libs | ||
| 82 | + | |-- Release | ||
| 83 | + | | |-- irc.lib # irc static library. Developers can perform secondary development (generation) based on this library | ||
| 84 | + |-- src | ||
| 85 | + | |-- AuthClient # Authentication function | ||
| 86 | + | |-- Image # Image-related | ||
| 87 | + | |-- Message # Packet-related | ||
| 88 | + | |-- Public # Tool library, common methods | ||
| 89 | + | |-- Settings # System startup item settings | ||
| 90 | + | |-- WebSocketClient # Implements WebSocket connections for the KVM client | ||
| 91 | + | |-- CMakeLists.txt | ||
| 92 | + | |-- KvmClient.cpp # Definition of the independent KVM client API | ||
| 93 | + | |-- KvmClient.hpp | ||
| 94 | + |-- .gitignore | ||
| 95 | + |-- Deployment Guide.docx | ||
| 96 | + |-- build.bat # Build tool (manually executed in the command line) | ||
| 97 | + |-- CMakeLists.txt | ||
| 98 | + |-- config.ini # Path configuration of the dependency tool (manual configuration is required) | ||
| 99 | + |-- LICENSE | ||
| 100 | + |-- README.md | ||
| 101 | +``` | ||
| 102 | + | ||
| 103 | +### 3.2 Detailed Deployment Process: | ||
| 104 | +``` | ||
| 105 | + For deployment details, clone the project to the local host and check the *deployment_guide.docx*. | ||
| 106 | +``` | ||