Tiny.cpp

一个极度微小、极度轻量、简单易用的基础库。

主要特点

模块化架构，可独立复用 src 目录下的任一模块，无需任何配置；
不依赖任何第三方库，仅使用跨平台架构设计；
简单易用，采用现代 C++ 标准（最低支持 C++11 标准）

包含模块

模块	路径	功能
TUI	`src/TUI`	终端用户界面，提供了基本的终端绘制功能，可更方便的渲染终端
OS	`src/OS`	操作系统，支持文件、路径的基本操作以及查看系统信息等基本功能
Net	`src/Net`	网络通信，提供 Socket、地址解析、主机名解析和高级套接字选项
DateTime	`src/DateTime`	日期时间，支持获取系统日期时间、时间戳计算等基本功能
CommandParser	`src/Parser`	命令解析器，提供基本的命令参数解析功能，可便于实现基本的命令行工具
IniParser	`src/Parser`	INI 配置文件解析器，支持解析、操作和序列化 INI 文件
Events	`src/Events`	事件系统，提供基本的组件，可方便实现定时器、异步等功能

安装

下载预编译项目

你可以直接在 Github Release 下载最新发布的预编译版本项目。

编译源代码项目

CMake

通过 Github 下载项目源代码：

git clone https://github.com/CatIsNotFound/Tiny.cpp.git

如要使用非稳定版本，请执行如下命令：

git clone https://github.com/CatIsNotFound/Tiny.cpp.git -b beta

通过 CMake 配置项目

cd Tiny.cpp
mkdir build ; cd build
cmake .. -DCMAKE_INSTALL_PREFIX=/path/to/Tiny.cpp -DTINY_BUILD_TEST=OFF

p.s: 请将 /path/to/Tiny.cpp 替换为实际安装的路径。

编译并安装本项目到本地
```
cmake --build . --target install
```

XMake

Note

若没有安装 XMake，请直接在终端下执行如下命令快速安装 XMake:

Linux/MacOS/Unix-like:

curl -fsSL https://xmake.io/shget.text | bash

wget https://xmake.io/shget.text -O - | bash

Windows:

irm https://xmake.io/psget.text | iex

通过 Github 下载项目源代码：

git clone https://github.com/CatIsNotFound/Tiny.cpp.git

如要使用非稳定版本，请执行如下命令：

git clone https://github.com/CatIsNotFound/Tiny.cpp.git -b beta

通过 XMake 配置项目
```
cd Tiny.cpp
xmake f --build_test=n
```
编译并安装本项目到本地
```
xmake
xmake package -o /path/to/install
```
p.s: 请将 /path/to/install 替换为实际安装的路径。

快速开始

复制源代码（最直接）

在 src 目录下直接复制任何一个目录对应的模块到自己的项目中，每个模块都包含一个头文件（*.hpp）和源文件（*.cpp）。

接着，请参考导入指南来导入 Tiny.cpp 项目。

通过 CMake 方式导入

若使用 CMake 作为主要的项目管理工具，建议直接采用 CMake 的方式导入 Tiny 项目。

p.s: CMake 下使用 Tiny 作为项目库名称，而不是 Tiny.cpp！

通过下载预编译二进制库或手动编译源代码到你的本地。
具体参照如下示例：

cmake_minimum_required(VERSION 3.24)
project(HelloWorld)

set(CMAKE_CXX_STANDARD 20)
set(CMAKE_PREFIX_PATH "/path/to/Tiny.cpp")
find_package(Tiny REQUIRED)

add_executable(${CMAKE_PROJECT_NAME} 
        main.cpp
        # ....
)

target_link_libraries(${CMAKE_PROJECT_NAME} PRIVATE
    Tiny::Tiny
)

通过 XMake 方式导入

若要使用 XMake 方式导入 Tiny.cpp 项目，需要先配置 XMake 项目，然后在项目中添加 Tiny.cpp 作为依赖项。

通过手动编译源代码到你的本地。
手动设置本地仓库

xmake repo -g -a local_repo /path/to/package

p.s: 请将 /path/to/package 替换为实际安装包的绝对路径。

你可通过如下命令以查看本地仓库是否添加：

xmake repo -l

具体参照如下示例：

add_rules("mode.debug", "mode.release")
set_languages("c++20")
add_requires("tiny.cpp")

target("HelloWorld")
    set_kind("binary")
    add_files("**.cpp")
    add_packages("tiny.cpp")

如何使用

以导入 TUI 模块为例，假设要使用 Terminal 模块以简单输出 Hello, Tiny.cpp!，请执行如下代码：

// 若使用 CMake 方式导入，请用以下方式导入：
#include <Tiny/TUI/Terminal.hpp>
// 若直接将 TUI 目录复制到你的项目里，大致可能以这种形式导入：
#include "TUI/Terminal.hpp"

using ter = Tiny::TUI::Terminal;

int main() {
   ter::printLine("Hello, Tiny.cpp!");   
   return 0;
}

P.S: 要查看更详细的帮助，请参考文档。

许可证说明

Tiny.cpp 采用 MIT 许可证许可协议，您可以在 LICENSE 文件或其它任一头文件或源文件中查看详细信息。

FilesExpand file tree

README_zh.md

Latest commit

History