Skip to content

Rewrite README.md: 项目定位、架构、命令速查表 #8

@qdriven

Description

@qdriven

README

Task 1: Rewrite the README.md

The purpose if this cli repo is chnaged overtime as features added.
The overall goal is to provide a cli tool to manage daily work more efficiently.
And aslo to provide a cli app for ai skill.
Most of code is generated by AI, but all inspired by my daily work. But Why I still need a cli tools?

  1. some deterministic tasks can be automated by cli tools to save some token cost
  2. provider cli app for ai skill to save some cost

Of cause AI can do it in runtime, but It is fine to have codes for deterministic tasks.

请把以上内容作为指引更新到READEME,说明项目的目的和方向,以及更新README.md文件,包括加入目前项目的技术栈,基本架构,目录结构,然后cli cheatsheet(命令列表,按照subcommand分类,说明功能和参数),build方法,然后主要的参考文档index,同时在检查docs目录里面主要功能是否和当前代码符合一致。

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationtask

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions