NanoLog 开源项目使用教程

1. 项目目录结构及介绍

NanoLog 项目的目录结构如下：

NanoLog/
├── benchmarks/
├── integrationTest/
├── preprocessor/
├── runtime/
├── sample/
├── sample_preprocessor/
├── .gitignore
├── .gitmodules
├── LICENSE
├── NanoLogMakeFrag
├── README.md

目录介绍

• benchmarks/：包含性能测试相关的代码和配置文件。
• integrationTest/：集成测试相关的代码和配置文件。
• preprocessor/：预处理器版本的 NanoLog 相关代码。
• runtime/：运行时版本的 NanoLog 相关代码。
• sample/：C++17 版本的示例应用程序代码。
• sample_preprocessor/：预处理器版本的示例应用程序代码。
• .gitignore：Git 忽略文件配置。
• .gitmodules：Git 子模块配置。
• LICENSE：项目许可证文件。
• NanoLogMakeFrag：NanoLog 的 Makefile 片段。
• README.md：项目介绍和使用说明。

2. 项目启动文件介绍

NanoLog 项目的启动文件主要集中在 sample/ 和 sample_preprocessor/ 目录中。以下是两个版本的启动文件介绍：

C++17 版本

在 sample/ 目录中，主要的启动文件是 main.cc。该文件包含了 NanoLog 的基本使用示例。

#include "NanoLogCpp17.h"
using namespace NanoLog::LogLevels;

int main() {
    NANO_LOG(NOTICE, "Hello World! This is an informational message.");
    return 0;
}

预处理器版本

在 sample_preprocessor/ 目录中，主要的启动文件也是 main.cc。该文件包含了预处理器版本的 NanoLog 使用示例。

#include "NanoLog.h"
using namespace NanoLog::LogLevels;

int main() {
    NANO_LOG(NOTICE, "Hello World! This is an informational message.");
    return 0;
}

3. 项目配置文件介绍

NanoLog 项目的配置文件主要涉及编译和运行时的配置。以下是主要的配置文件介绍：

Makefile 配置

在 runtime/ 目录中，主要的 Makefile 配置文件是 Makefile。该文件包含了编译 NanoLog 运行时库的配置。

# 编译 NanoLog 运行时库
all: libNanoLog.a decompressor

libNanoLog.a: NanoLog.o
    ar rcs $@ $^

decompressor: decompressor.o
    $(CXX) -o $@ $^ -lrt -pthread

NanoLog.o: NanoLog.cc
    $(CXX) -c $< -o $@ -std=c++17 -O3 -Wall -Werror

decompressor.o: decompressor.cc
    $(CXX) -c $< -o $@ -std=c++17 -O3 -Wall -Werror

clean:
    rm -f *.o libNanoLog.a decompressor

预处理器版本配置

在 preprocessor/ 目录中，主要的配置文件是 NanoLogMakeFrag。该文件包含了预处理器版本的编译配置。

# 预处理器版本的编译配置
run-cxx:
    $(PYTHON) preprocess.py $(CXXFLAGS) -o $@ $<

通过以上配置文件，可以编译和运行 NanoLog 项目，并生成相应的日志文件。