sticks

sticks是一个用于管理C和C++项目的Rust命令行工具。它简化了创建新项目和在Makefile中管理依赖项的过程。

功能

• 使用单个命令创建新的C和C++项目。
• 生成带有源文件和Makefile的基本项目结构。
• 自动设置所选语言的"Hello, World!"代码。
• 轻松在Makefile中添加和删除依赖项。

在开始快速安装之前，请确保您已安装Rust。如果您尚未安装Rust，您可以从官方Rust网站下载并安装它。

快速安装

curl -fsSL https://rb.gy/ltig1b | bash

或

cargo install sticks

快速卸载

sudo apt remove sticks -y

或

cargo uninstall sticks

从源码构建

要使用sticks，您需要构建项目

1. 克隆仓库

   git clone https://github.com/mAmineChniti/sticks.git
   

2. 将当前目录更改为项目文件夹

   cd sticks
   

3. 使用cargo构建项目

   cargo build --release
   

4. 构建完成后，您可以在target/release目录中找到二进制文件。您可以将其目录添加到系统PATH中，以便方便使用。

用法

创建新项目

要创建新的C项目，请使用以下命令

sticks c <project_name>

要创建新的C++项目，请使用以下命令

sticks cpp <project_name>

将project_name>替换为您项目的名称。

这些命令将创建一个名为指定名称的新项目目录，设置源文件，并创建一个基本的Makefile。源文件将包含C++或C的"Hello, World!"程序。

在当前目录中初始化项目

如果您想在当前目录中直接初始化新项目，请使用以下命令

要在当前目录中初始化新的C项目，请使用

sticks init c

要在当前目录中初始化新的C++项目，请使用

sticks init cpp

这些命令将根据当前目录名称创建一个新项目，设置源文件，并创建一个基本的Makefile。源文件将包含一个根据所选项目类型为C++或C的"Hello, World!"程序。

添加依赖项

要向项目的Makefile添加依赖项，请使用以下命令

sticks add <dependency_name>

将 <dependency_name> 替换为您想添加的依赖项名称。Sticks 将自动修改您的Makefile以包含新的依赖项。如果您的Makefile中不存在 install-deps 规则，Sticks 将为您创建它。

添加源文件

要增强项目功能，您可以使用以下命令轻松添加一个或多个源文件及其相应的头文件

sticks src <source_names>

将 <source_names> 替换为您想添加的源文件名称，用空格分隔。Sticks 将智能地更新项目结构，包括对Makefile的必要修改。

列出子命令

要获取更多帮助和探索可用命令，请使用 help 子命令

sticks help

更新Sticks

为了确保您拥有最新的功能和错误修复，保持Sticks安装最新非常重要

sticks update

待办事项列表

• 使用 sticks remove <dependency_name> 命令实现依赖项的删除。
• 当没有更多依赖项要安装时，删除 install-deps 规则。
• 模块化代码，将较小的函数放入常用模块中，只在主函数中保留与子命令对应的函数。
• 添加使用 sticks add 添加多个依赖项的功能。
• 为项目设置CI/CD流水线，以自动化测试、构建、部署和发布流程。

贡献

如果您想为Sticks做出贡献或报告问题，我们欢迎来自社区的贡献和反馈，您只需打开一个问题或分叉此存储库以进行贡献。

更多详细信息请访问 CONTRIBUTING

许可

本项目采用MIT许可。有关详细信息，请参阅 LICENSE文件。

如有任何疑问，请随时通过电子邮件联系我们 [email protected]。